|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.palo.api.utils.ElementPath
public class ElementPath
An ElementPath
is a distinct reference to an
inside a structure of multiple
Element
s. Therefore a path could be build up of
several so called parts where each part describes a path inside a single
Dimension
.
Dimension
NOTE: the assemble of the ElementPath
is determined by
the order at which the single parts are added. It is therefore important
to add the path parts of each dimension according to the dimension hierarchy.
toString()
and the restore(Dimension[], String)
can
be used to save and restore an ElementPath
.
Field Summary | |
---|---|
static java.lang.String |
DIM_HIER_DELIM
|
static java.lang.String |
DIMENSION_DELIM
|
static java.lang.String |
ELEMENT_DELIM
|
Constructor Summary | |
---|---|
ElementPath()
Default constructor which creates an empty ElementPath
instance. |
|
ElementPath(Element[] elements)
Creates an ElementPath instance which consists of the
given Element s. |
Method Summary | |
---|---|
void |
addPart(Dimension dimension,
Element[] path)
Adds a new part to this element path with the given path for the specified
|
void |
addPart(Hierarchy hierarchy,
Element[] path)
|
boolean |
contains(Dimension dimension)
Checks if the given is part of this
element paths. |
boolean |
contains(Hierarchy hierarchy)
|
ElementPath |
copy()
Returns a copy of this element path instance |
boolean |
equals(java.lang.Object obj)
|
Element[] |
getComplete()
|
Dimension[] |
getDimensions()
Returns all s which are part of this
element path. |
Hierarchy[] |
getHierarchies()
|
Element[] |
getPart(Dimension dimension)
Returns the path part which corresponds to the given
|
Element[] |
getPart(Hierarchy hierarchy)
|
int |
hashCode()
|
static ElementPath |
restore(Dimension[] dimensions,
java.lang.String pathStr)
Restores the element path specified by the given s and element path string |
static ElementPath |
restore(Hierarchy[] hierarchies,
java.lang.String pathStr)
|
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String ELEMENT_DELIM
public static final java.lang.String DIMENSION_DELIM
public static final java.lang.String DIM_HIER_DELIM
Constructor Detail |
---|
public ElementPath()
ElementPath
instance.
public ElementPath(Element[] elements)
ElementPath
instance which consists of the
given Element
s.
elements
- the path Element
sMethod Detail |
---|
public final void addPart(Dimension dimension, Element[] path)
Dimension
dimension
- pathPart
- public final void addPart(Hierarchy hierarchy, Element[] path)
public final Element[] getComplete()
public final boolean contains(Dimension dimension)
Dimension
is part of this
element paths.
true
if Dimension
is part of
this element paths, false
otherwisepublic final boolean contains(Hierarchy hierarchy)
public final Dimension[] getDimensions()
Dimension
s which are part of this
element path.
Dimension
s which build up this pathpublic final Hierarchy[] getHierarchies()
public final Element[] getPart(Dimension dimension) throws PaloAPIException
Dimension
dimension
- the Dimension
which contains the
path part
Element
s
PaloAPIException
- if no path part could be determined, i.e. the
given Dimension
is not part of this element pathpublic final Element[] getPart(Hierarchy hierarchy) throws PaloAPIException
PaloAPIException
public final java.lang.String toString()
toString
in class java.lang.Object
public ElementPath copy()
public final boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public final int hashCode()
hashCode
in class java.lang.Object
public static final ElementPath restore(Dimension[] dimensions, java.lang.String pathStr)
Dimension
s and element path string
dimensions
- the code>Dimension
s which build up this
element pathpathStr
- an element path definition string
public static final ElementPath restore(Hierarchy[] hierarchies, java.lang.String pathStr)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |