|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Element
Element
.
Elements belong to Dimension
s.
A dimension is the parent of several distinct Element
s. HOwever
if an Element
is consolidated more than once in a specific
dimension than traversing the children of all elements will encounter
a given element multiple times.
Within the scope of its single parent Dimension
, a dimension
is uniquely identified by its name as returned by
getName()
.
PaloAPIException
Field Summary | |
---|---|
static int |
ELEMENTTYPE_CONSOLIDATED
Identifier as returned by getType() that
identifies consolidated elements. |
static java.lang.String |
ELEMENTTYPE_CONSOLIDATED_STRING
String constant mapped to the element-type ELEMENTTYPE_CONSOLIDATED . |
static int |
ELEMENTTYPE_NUMERIC
Identifier as returned by getType() that
identifies numeric elements. |
static java.lang.String |
ELEMENTTYPE_NUMERIC_STRING
String constant mapped to the element-type ELEMENTTYPE_NUMERIC . |
static int |
ELEMENTTYPE_RULE
Identifier as returned by getType() that
identifies rule elements. |
static java.lang.String |
ELEMENTTYPE_RULE_STRING
String constant mapped to the element-type ELEMENTTYPE_RULE . |
static int |
ELEMENTTYPE_STRING
Identifier as returned by getType() that
identifies string elements. |
static java.lang.String |
ELEMENTTYPE_STRING_STRING
String constant mapped to the element-type ELEMENTTYPE_STRING . |
Fields inherited from interface org.palo.api.PaloObject |
---|
TYPE_ATTRIBUTE, TYPE_NORMAL, TYPE_SYSTEM, TYPE_USER_INFO |
Method Summary | |
---|---|
java.lang.Object |
getAttributeValue(Attribute attribute)
Returns the value of the specified Attribute |
java.lang.Object[] |
getAttributeValues()
Returns the values of all Attribute s currently registered with
this element |
int |
getChildCount()
Returns the number of child-elements in the consolidation-hierarchy. |
Element[] |
getChildren()
Returns the child-elements in the consolidation-hierarchy. |
Consolidation |
getConsolidationAt(int index)
Returns the Consolidation stored at the given index. |
int |
getConsolidationCount()
Returns the number of Consolidation s of this instance. |
Consolidation[] |
getConsolidations()
Returns an array of Consolidation instances available
for this instance. |
int |
getDepth()
The depth describes how deep the element is located inside its dimension hierarchy related to its root elements, i.e. the depth is the length of the longest path which starts from the root elements and ends in this element. |
Dimension |
getDimension()
Deprecated. use getHierarchy() instead. |
Hierarchy |
getHierarchy()
Returns the parent Hierarchy of this instance. |
int |
getLevel()
The level describes how high the element is located inside its dimension hierarchy related to its base-elements. |
java.lang.String |
getName()
Returns the name of this Element |
int |
getParentCount()
Returns the number of parent-elements in the consolidation-hierarchy. |
Element[] |
getParents()
Returns the parent-elements in the consolidation-hierarchy. |
int |
getPosition()
Returns the position of this element within its dimension |
int |
getType()
Returns the type of this Element , one of
the following is returned:
ELEMENTTYPE_NUMERIC
ELEMENTTYPE_STRING
ELEMENTTYPE_CONSOLIDATED
ELEMENTTYPE_RULE
|
java.lang.String |
getTypeAsString()
Returns a string description of the Element 's type. |
void |
move(int newPosition)
Moves this element to the given position in its dimension |
void |
rename(java.lang.String name)
Renames this Element . |
void |
setAttributeValue(Attribute attribute,
java.lang.Object value)
Sets the value for the given Attribute instance |
void |
setAttributeValues(Attribute[] attributes,
java.lang.Object[] values)
Sets the values for the given Attribute instances |
void |
setType(int type)
|
void |
updateConsolidations(Consolidation[] consolidations)
Updates the consolidation-infos of this Element . |
Methods inherited from interface org.palo.api.PaloObject |
---|
getId |
Methods inherited from interface org.palo.api.Writable |
---|
canBeModified, canCreateChildren |
Field Detail |
---|
static final int ELEMENTTYPE_NUMERIC
getType()
that
identifies numeric elements.
static final int ELEMENTTYPE_STRING
getType()
that
identifies string elements.
static final int ELEMENTTYPE_CONSOLIDATED
getType()
that
identifies consolidated elements.
static final int ELEMENTTYPE_RULE
getType()
that
identifies rule elements.
static final java.lang.String ELEMENTTYPE_NUMERIC_STRING
ELEMENTTYPE_NUMERIC
.
static final java.lang.String ELEMENTTYPE_STRING_STRING
ELEMENTTYPE_STRING
.
static final java.lang.String ELEMENTTYPE_CONSOLIDATED_STRING
ELEMENTTYPE_CONSOLIDATED
.
static final java.lang.String ELEMENTTYPE_RULE_STRING
ELEMENTTYPE_RULE
.
Method Detail |
---|
java.lang.String getName()
Element
getName
in interface NamedEntity
Element
.Dimension getDimension()
getHierarchy()
instead.
Dimension
of this instance.
Dimension
of this instance.Hierarchy getHierarchy()
Hierarchy
of this instance.
Hierarchy
of this instance.int getType()
Element
, one of
the following is returned:
getType
in interface PaloObject
Element
.void setType(int type)
java.lang.String getTypeAsString()
Element
's type.
The returned value is a mere description only and is not to be
used as a basis for comparisions and the like.
Element
's type.int getDepth()
int getLevel()
void rename(java.lang.String name)
Element
.
name
- the new name for this Element
.int getConsolidationCount()
Consolidation
s of this instance.
If this Element
is not consolidated as returned
by getType()
then 0 is returned.
Consolidation
s of this instance.Consolidation getConsolidationAt(int index)
Consolidation
stored at the given index.
If the index does not correspond to a legal position
in the internally managed array of consolidations of this
instance, then null
is returned.
index
- the index
Consolidation
stored at the given index
or null
.Consolidation[] getConsolidations()
Consolidation
instances available
for this instance.
If this Element
is not consolidated as returned
by getType()
then 0 is returned.
The returned array is a copy of the internal datastructure. Changing the returned array does not change this instance.
Consolidation
instances available
for this connection.void updateConsolidations(Consolidation[] consolidations)
Element
.
Note: it is required to call Dimension.reload(boolean)
or
Hierarchy.reload(boolean)
afterwards to reflect the structure
changes. This separation is done to allow multiple updates of element
consolidations and to reload structure only once.
consolidations
- the consolidations to use for this
Element
.int getParentCount()
Element[] getParents()
int getChildCount()
Element[] getChildren()
int getPosition()
void move(int newPosition)
newPosition
- java.lang.Object getAttributeValue(Attribute attribute)
Attribute
attribute
- the Attribute
instance to get the value from
java.lang.Object[] getAttributeValues()
Attribute
s currently registered with
this element
void setAttributeValue(Attribute attribute, java.lang.Object value)
Attribute
instance
attribute
- the Attribute
to set the value ofvalue
- the new attribute valuevoid setAttributeValues(Attribute[] attributes, java.lang.Object[] values)
Attribute
instances
attributes
- the Attribute
s to set the values ofvalues
- the new attribute values
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |