|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.navigation.DimVal
public class DimVal
A dimension value is the lowest-level building block that compose dimensions, navigations,
and classifications of records. A Dimension
is a collection
of related dimension values, organized into a tree.
The top-most dimension value in a dimension tree is known as the
dimension root. A dimension root always has the same name as its dimension.
Every dimension value has a unique ID.
Dimension values are tags that classify the records in a data set. Tagging a record with a dimension value identifies the record as a valid result when that dimension value is selected in a navigation query.
Method Summary | |
---|---|
long |
getDimensionId()
Gets the ID of the dimension to which this value belongs. |
String |
getDimensionName()
Gets the name of the dimension to which this dimension value belongs. |
long |
getId()
Gets the ID of this dimension value. |
String |
getName()
Gets the name of this dimension value. |
PropertyMap |
getProperties()
Gets the properties associated with this dimension value. |
boolean |
isLeaf()
Indicates if this dimension value is a leaf. |
boolean |
isMultiSelectAnd()
Indicates if this dimension value supports "multi-select and" functionality. |
boolean |
isMultiSelectOr()
Indicates if this dimension value supports "multi-select or" functionality. |
boolean |
isNavigable()
Indicates if this dimension value is navigable. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public boolean isLeaf()
true
if this dimension value is a leaf (has no child dimension values).
false
if this dimension value has child dimension values.public boolean isNavigable()
true
if this value is navigable,
false
if it is not.public boolean isMultiSelectAnd()
true
if this value is "multi-select and" capable,
false
if it is not.public boolean isMultiSelectOr()
true
if this value is "multi-select or" capable,
false
if it is not.public String getName()
public long getId()
public String getDimensionName()
Dimension
to which this dimension value belongs.public long getDimensionId()
Dimension
to which this value belongs.public PropertyMap getProperties()
getProperties
in interface PropertyContainer
PropertyMap
object containing the properties associated
with this dimension value. If there are no properties, a valid property
list will still be returned.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |