|
Metadata |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Hierarchy
An arrangement of members of a dimension into levels that are based on parent-child relationships. Members of a hierarchy are arranged from more general to more specific. For example, in a Time dimension, a hierarchy might consist of the members Year, Quarter, Month, and Day. In a Geography dimension, a hierarchy might consist of the members Country, State or Province, and City. More than one hierarchy can be defined for a dimension. Each hierarchy provides a navigational path that enables users to drill down to increasing levels of detail. See also CalculatedMember, Level.
Attributes of Hierarchy are:
Associations of Hierarchy are:
factory
create methods. // create a store to contain your objects for this change. If you do not have an existing object // or store to use. You may obtain the store from another object by using Object.getObjectStore(). MdFactory factory; //where "factory" is a valid MdFactory instance MdObjectStore objectStore = factory.createObjectStore(); Hierarchy myObject = (Hierarchy) factory.createComplexMetadataObject(objectStore, "Hierarchy_Object", MetadataObjects.HIERARCHY, "AAAAAAAA"); myObject.updateMetadataAll(); // Write object to server objectStore.dispose(); // dispose of the object store if it is no longer needed
MdOMIUtil
.
updateMetadataAll
method.
delete
method can be used.
This will flag the object as being deleted on the client, and will require an update call to persist
the change to the server.
Field Summary | |
---|---|
static java.lang.String |
ASSOCIATION_CALCULATEDMEMBERS_NAME
Constant used for the name of the CalculatedMembers association. |
static java.lang.String |
ASSOCIATION_CUBES_NAME
Constant used for the name of the Cubes association. |
static java.lang.String |
ASSOCIATION_LEVELS_NAME
Constant used for the name of the Levels association. |
static java.lang.String |
ASSOCIATION_NAMEDSETS_NAME
Constant used for the name of the NamedSets association. |
static java.lang.String |
ASSOCIATION_OLAPPROPERTIES_NAME
Constant used for the name of the OLAPProperties association. |
static java.lang.String |
ASSOCIATION_OWNINGDIMENSION_NAME
Constant used for the name of the OwningDimension association. |
static java.lang.String |
ASSOCIATION_ROOTHIERARCHYLEVEL_NAME
Constant used for the name of the RootHierarchyLevel association. |
static java.lang.String |
ATTRIBUTE_ALLMEMBER_NAME
Constant used for the name of the AllMember attribute. |
static java.lang.String |
ATTRIBUTE_CARDINALITY_NAME
Constant used for the name of the Cardinality attribute. |
static java.lang.String |
ATTRIBUTE_DEFAULTMEMBER_NAME
Constant used for the name of the DefaultMember attribute. |
static java.lang.String |
ATTRIBUTE_UNIQUENAME_NAME
Constant used for the name of the UniqueName attribute. |
Fields inherited from interface com.sas.metadata.remote.PrimaryType |
---|
ASSOCIATION_FAVORITESCONTAINERS_NAME, ATTRIBUTE_ISHIDDEN_NAME, ATTRIBUTE_PUBLICTYPE_NAME |
Fields inherited from interface com.sas.metadata.remote.MdObjectBase |
---|
ATTRIBUTE_DESC_NAME, ATTRIBUTE_ID_NAME, ATTRIBUTE_METADATACREATED_NAME, ATTRIBUTE_METADATAUPDATED_NAME, ATTRIBUTE_NAME_NAME |
Method Summary | |
---|---|
java.lang.String |
getAllMember()
Gets the String value of AllMember |
int |
getAllMemberMaxLength()
Gets the maximum length of AllMember |
int |
getAllMemberState()
Gets the Metadata State of AllMember |
AssociationList |
getCalculatedMembers()
Gets the Association list of CalculatedMembers |
AssociationList |
getCalculatedMembers(boolean fGoToServer)
Gets the Associationlist of CalculatedMembers |
double |
getCardinality()
Gets the double value of Cardinality |
int |
getCardinalityState()
Gets the Metadata State of Cardinality |
AssociationList |
getCubes()
Gets the Association list of Cubes |
AssociationList |
getCubes(boolean fGoToServer)
Gets the Associationlist of Cubes |
java.lang.String |
getDefaultMember()
Gets the String value of DefaultMember |
int |
getDefaultMemberMaxLength()
Gets the maximum length of DefaultMember |
int |
getDefaultMemberState()
Gets the Metadata State of DefaultMember |
AssociationList |
getLevels()
Gets the Association list of Levels |
AssociationList |
getLevels(boolean fGoToServer)
Gets the Associationlist of Levels |
AssociationList |
getNamedSets()
Gets the AssociationList of NamedSets |
AssociationList |
getNamedSets(boolean fGoToServer)
Gets the Associationlist of NamedSets |
AssociationList |
getOLAPProperties()
Gets the Association list of OLAPProperties |
AssociationList |
getOLAPProperties(boolean fGoToServer)
Gets the Associationlist of OLAPProperties |
Dimension |
getOwningDimension()
Gets the Dimension for OwningDimension |
AssociationList |
getOwningDimensions()
Gets the AssociationList of OwningDimensions |
AssociationList |
getOwningDimensions(boolean fGoToServer)
Gets the Associationlist of OwningDimensions |
HierarchyLevel |
getRootHierarchyLevel()
Gets the HierarchyLevel for RootHierarchyLevel |
AssociationList |
getRootHierarchyLevels()
Gets the Association list of RootHierarchyLevels |
AssociationList |
getRootHierarchyLevels(boolean fGoToServer)
Gets the Associationlist of RootHierarchyLevels |
java.lang.String |
getUniqueName()
Gets the String value of UniqueName |
int |
getUniqueNameMaxLength()
Gets the maximum length of UniqueName |
int |
getUniqueNameState()
Gets the Metadata State of UniqueName |
void |
initializePredObjects()
(S) Adds the Associated objects to the predObjects which are: NamedSets OwningDimension |
void |
initializeRequiredObjects()
(S) This initializes the Required Objects(Roles) which are: OwningDimension |
void |
setAllMember(java.lang.String inAllMember)
Sets the AllMember value and sets the state to MetadataState.LOCAL. |
void |
setAllMember(java.lang.String inAllMember,
int state)
Sets the AllMember Metadata State. |
void |
setAllMemberState(int state)
Sets the Metadata State of AllMember . |
void |
setCalculatedMembers(AssociationList list)
Sets the CalculatedMembers list to be list . |
void |
setCalculatedMembers(AssociationList inObjects,
int state)
Sets the entire CalculatedMembers list to match the passed in AssociationList, sets the state of the CalculatedMembers |
void |
setCardinality(double inCardinality)
Sets the Cardinality value and sets the state to MetadataState.LOCAL. |
void |
setCardinality(double inCardinality,
int state)
Sets the Cardinality Metadata State. |
void |
setCardinality(java.lang.String inCardinality)
Sets the Cardinality value and sets the state to MetadataState.LOCAL |
void |
setCardinality(java.lang.String inCardinality,
int state)
Sets the Cardinality value and Metadata State. |
void |
setCardinalityState(int state)
Sets the Metadata State of Cardinality . |
void |
setCubes(AssociationList list)
Sets the Cubes list to be list . |
void |
setCubes(AssociationList inObjects,
int state)
Sets the entire Cubes list to match the passed in AssociationList, sets the state of the Cubes |
void |
setDefaultMember(java.lang.String inDefaultMember)
Sets the DefaultMember value and sets the state to MetadataState.LOCAL. |
void |
setDefaultMember(java.lang.String inDefaultMember,
int state)
Sets the DefaultMember Metadata State. |
void |
setDefaultMemberState(int state)
Sets the Metadata State of DefaultMember . |
void |
setLevels(AssociationList list)
Sets the Levels list to be list . |
void |
setLevels(AssociationList inObjects,
int state)
Sets the entire Levels list to match the passed in AssociationList, sets the state of the Levels |
void |
setNamedSets(AssociationList list)
Sets the NamedSets list to be list . |
void |
setNamedSets(AssociationList inObjects,
int state)
Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList |
void |
setOLAPProperties(AssociationList list)
Sets the OLAPProperties list to be list . |
void |
setOLAPProperties(AssociationList inObjects,
int state)
Sets the entire OLAPProperties list to match the passed in AssociationList, sets the state of the OLAPProperties |
void |
setOwningDimension(Dimension inObject)
Sets the OwningDimensions list 0th element to be inObject . |
void |
setOwningDimensions(AssociationList list)
Sets the OwningDimensions list to be list . |
void |
setOwningDimensions(AssociationList list,
int state)
Sets the OwningDimensions list to be list . |
void |
setRootHierarchyLevel(HierarchyLevel inObject)
Sets the RootHierarchyLevels list 0th element to be inObject . |
void |
setRootHierarchyLevels(AssociationList list)
Sets the RootHierarchyLevels list to be list . |
void |
setRootHierarchyLevels(AssociationList list,
int state)
Sets the RootHierarchyLevels list to be list . |
void |
setUniqueName(java.lang.String inUniqueName)
Sets the UniqueName value and sets the state to MetadataState.LOCAL. |
void |
setUniqueName(java.lang.String inUniqueName,
int state)
Sets the UniqueName Metadata State. |
void |
setUniqueNameState(int state)
Sets the Metadata State of UniqueName . |
Methods inherited from interface com.sas.metadata.remote.PrimaryType |
---|
getFavoritesContainers, getFavoritesContainers, getIsHidden, getIsHiddenState, getPublicType, getPublicTypeMaxLength, getPublicTypeState, setFavoritesContainers, setFavoritesContainers, setIsHidden, setIsHidden, setIsHidden, setIsHidden, setIsHiddenState, setPublicType, setPublicType, setPublicTypeState |
Methods inherited from interface com.sas.metadata.remote.MdObjectBaseXML |
---|
closeUpdateMetadataXML, createEmptyXML, createObjectRefreshXML, createObjectXML, createObjectXML, createUpdateAssociationXML, createUpdateAssociationXML, createUpdateSimpleXML, doCreateUpdateXML, getUpdateSimpleSubstring, updateMetadataAll |
Field Detail |
---|
static final java.lang.String ATTRIBUTE_CARDINALITY_NAME
Cardinality: The number of levels in the hierarchy.
static final java.lang.String ATTRIBUTE_UNIQUENAME_NAME
UniqueName: The unique name for this hierarchy.
static final java.lang.String ATTRIBUTE_DEFAULTMEMBER_NAME
DefaultMember: The default member for the hierarchy.
static final java.lang.String ATTRIBUTE_ALLMEMBER_NAME
AllMember: This is the member at the highest level of a rollup in the hierarchy.
static final java.lang.String ASSOCIATION_NAMEDSETS_NAME
NamedSets: The named sets for this hierarchy.
static final java.lang.String ASSOCIATION_OWNINGDIMENSION_NAME
OwningDimension: The dimension that contains this hierarchy.
static final java.lang.String ASSOCIATION_CALCULATEDMEMBERS_NAME
CalculatedMembers: The calculated members for this hierarchy.
static final java.lang.String ASSOCIATION_CUBES_NAME
Cubes: The list of cubes that support this hierarchy.
static final java.lang.String ASSOCIATION_LEVELS_NAME
Levels: The list of levels that comprise this hierarchy.
static final java.lang.String ASSOCIATION_OLAPPROPERTIES_NAME
OLAPProperties: The list of OLAP properties for this hierarchy.
static final java.lang.String ASSOCIATION_ROOTHIERARCHYLEVEL_NAME
RootHierarchyLevel: The root level for this hierarchy.
Method Detail |
---|
void initializeRequiredObjects() throws java.rmi.RemoteException
OwningDimension
initializeRequiredObjects
in interface MdObjectBaseUtil
initializeRequiredObjects
in interface PrimaryType
initializeRequiredObjects
in interface Root
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.void initializePredObjects() throws java.rmi.RemoteException
NamedSets
OwningDimension
initializePredObjects
in interface MdObjectBase
initializePredObjects
in interface PrimaryType
initializePredObjects
in interface Root
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.double getCardinality() throws java.rmi.RemoteException
double
value of Cardinality
Cardinality
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getCardinalityState() throws java.rmi.RemoteException
Cardinality
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getUniqueName() throws java.rmi.RemoteException
String
value of UniqueName
UniqueName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getUniqueNameState() throws java.rmi.RemoteException
UniqueName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getUniqueNameMaxLength() throws java.rmi.RemoteException
UniqueName
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getDefaultMember() throws java.rmi.RemoteException
String
value of DefaultMember
DefaultMember
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getDefaultMemberState() throws java.rmi.RemoteException
DefaultMember
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getDefaultMemberMaxLength() throws java.rmi.RemoteException
DefaultMember
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.java.lang.String getAllMember() throws java.rmi.RemoteException
String
value of AllMember
AllMember
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getAllMemberState() throws java.rmi.RemoteException
AllMember
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.int getAllMemberMaxLength() throws java.rmi.RemoteException
AllMember
java.rmi.RemoteException
- If error connecting/communicating to/with remote object.AssociationList getNamedSets() throws java.rmi.RemoteException, MdException
NamedSets
NamedSets
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getOwningDimensions() throws java.rmi.RemoteException, MdException
OwningDimensions
OwningDimensions
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
Dimension getOwningDimension() throws java.rmi.RemoteException, MdException
Dimension
for OwningDimension
Dimension
( null
if not set) of OwningDimension
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getCalculatedMembers() throws java.rmi.RemoteException, MdException
CalculatedMembers
CalculatedMembers
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getCubes() throws java.rmi.RemoteException, MdException
Cubes
Cubes
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getLevels() throws java.rmi.RemoteException, MdException
Levels
Levels
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getOLAPProperties() throws java.rmi.RemoteException, MdException
OLAPProperties
OLAPProperties
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getRootHierarchyLevels() throws java.rmi.RemoteException, MdException
RootHierarchyLevels
RootHierarchyLevels
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.HierarchyLevel getRootHierarchyLevel() throws java.rmi.RemoteException, MdException
HierarchyLevel
for RootHierarchyLevel
HierarchyLevel
( null
if not set ) of RootHierarchyLevel
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getNamedSets(boolean fGoToServer) throws java.rmi.RemoteException, MdException
NamedSets
fGoToServer
- boolean Get the value from the server.
NamedSets
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getOwningDimensions(boolean fGoToServer) throws java.rmi.RemoteException, MdException
OwningDimensions
fGoToServer
- boolean Get the value from the server.
OwningDimensions
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getCalculatedMembers(boolean fGoToServer) throws java.rmi.RemoteException, MdException
CalculatedMembers
fGoToServer
- boolean Get the value from the server.
CalculatedMembers
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getCubes(boolean fGoToServer) throws java.rmi.RemoteException, MdException
Cubes
fGoToServer
- boolean Get the value from the server.
Cubes
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getLevels(boolean fGoToServer) throws java.rmi.RemoteException, MdException
Levels
fGoToServer
- boolean Get the value from the server.
Levels
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getOLAPProperties(boolean fGoToServer) throws java.rmi.RemoteException, MdException
OLAPProperties
fGoToServer
- boolean Get the value from the server.
OLAPProperties
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.AssociationList getRootHierarchyLevels(boolean fGoToServer) throws java.rmi.RemoteException, MdException
RootHierarchyLevels
fGoToServer
- boolean Get the value from the server.
RootHierarchyLevels
which can be of type: java.rmi.RemoteException
- If error connecting/communicating to/with remote object.
MdException
- If error getting/setting part of the object.void setCardinality(double inCardinality) throws java.rmi.RemoteException
Cardinality
value and sets the state to MetadataState.LOCAL.
inCardinality
- double
java.rmi.RemoteException
- If error communicating with remote object.void setCardinality(double inCardinality, int state) throws java.rmi.RemoteException
Cardinality
Metadata State.
inCardinality
- doublestate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setCardinality(java.lang.String inCardinality) throws java.rmi.RemoteException
Cardinality
value and sets the state to MetadataState.LOCAL
inCardinality
- String
java.rmi.RemoteException
- If error communicating with remote object.void setCardinality(java.lang.String inCardinality, int state) throws java.rmi.RemoteException
Cardinality
value and Metadata State.
inCardinality
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setCardinalityState(int state) throws java.rmi.RemoteException
Cardinality
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setUniqueName(java.lang.String inUniqueName) throws java.rmi.RemoteException
UniqueName
value and sets the state to MetadataState.LOCAL.
inUniqueName
- String
java.rmi.RemoteException
- If error communicating with remote object.void setUniqueName(java.lang.String inUniqueName, int state) throws java.rmi.RemoteException
UniqueName
Metadata State.
inUniqueName
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setUniqueNameState(int state) throws java.rmi.RemoteException
UniqueName
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setDefaultMember(java.lang.String inDefaultMember) throws java.rmi.RemoteException
DefaultMember
value and sets the state to MetadataState.LOCAL.
inDefaultMember
- String
java.rmi.RemoteException
- If error communicating with remote object.void setDefaultMember(java.lang.String inDefaultMember, int state) throws java.rmi.RemoteException
DefaultMember
Metadata State.
inDefaultMember
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setDefaultMemberState(int state) throws java.rmi.RemoteException
DefaultMember
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setAllMember(java.lang.String inAllMember) throws java.rmi.RemoteException
AllMember
value and sets the state to MetadataState.LOCAL.
inAllMember
- String
java.rmi.RemoteException
- If error communicating with remote object.void setAllMember(java.lang.String inAllMember, int state) throws java.rmi.RemoteException
AllMember
Metadata State.
inAllMember
- Stringstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setAllMemberState(int state) throws java.rmi.RemoteException
AllMember
.
state
- int
java.rmi.RemoteException
- If error communicating with remote object.void setNamedSets(AssociationList list) throws java.rmi.RemoteException
NamedSets
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setNamedSets(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setOwningDimensions(AssociationList list) throws java.rmi.RemoteException
OwningDimensions
list to be list
. Object of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setOwningDimensions(AssociationList list, int state) throws java.rmi.RemoteException
OwningDimensions
list to be list
. Object of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setOwningDimension(Dimension inObject) throws java.rmi.RemoteException
OwningDimensions
list 0th element to be inObject
.
inObject
- Dimension
java.rmi.RemoteException
- If error communicating with remote object.void setCalculatedMembers(AssociationList list) throws java.rmi.RemoteException
CalculatedMembers
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setCalculatedMembers(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setCubes(AssociationList list) throws java.rmi.RemoteException
Cubes
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setCubes(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setLevels(AssociationList list) throws java.rmi.RemoteException
Levels
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setLevels(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setOLAPProperties(AssociationList list) throws java.rmi.RemoteException
OLAPProperties
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setOLAPProperties(AssociationList inObjects, int state) throws java.rmi.RemoteException
inObjects
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setRootHierarchyLevels(AssociationList list) throws java.rmi.RemoteException
RootHierarchyLevels
list to be list
. Objects of which can be of type:
list
- AssociationList
java.rmi.RemoteException
- If error communicating with remote object.void setRootHierarchyLevels(AssociationList list, int state) throws java.rmi.RemoteException
RootHierarchyLevels
list to be list
. Objects of which can be of type:
list
- AssociationListstate
- int
java.rmi.RemoteException
- If error communicating with remote object.void setRootHierarchyLevel(HierarchyLevel inObject) throws java.rmi.RemoteException
RootHierarchyLevels
list 0th element to be inObject
.
inObject
- HierarchyLevel
java.rmi.RemoteException
- If error communicating with remote object.
|
Metadata |
|
| |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |