public class OdiLevel extends AbstractRepositoryEntity implements ILevel
Constructor and Description |
---|
OdiLevel(OdiDimension owningDim,
OdiLevel baseLevel,
java.lang.String levelName)
OdiLevel constructor
The new level will copy base level's attributes including data type/ surrogate key/ SCD2 type/ SCD3 effective date attribute/
SCD3 prior value attribute/ defaultValue, and also natural key members of the base level.
|
OdiLevel(OdiDimension owningDim,
java.lang.String levelName)
OdiLevel constructor.
|
Modifier and Type | Method and Description |
---|---|
void |
addLevelAttribute(OdiLevelAttribute levelAttr)
Add a level attribute to this level.
|
void |
addNaturalKeyMember(OdiLevelAttribute levelAttr)
Add a natural key member to the list of natural key objects owned by this level.
|
void |
addNaturalKeyMember(OdiNaturalKeyMember keyMember)
Add a natural key member attribute to the list of natural key objects owned by this level.
|
void |
addParentRef(OdiParentRef pRef)
Add a parent ref objects that will be associated with this level.
|
OdiLevelAttribute |
findLevelAttribute(java.lang.String name)
Find a level attribute with the specified name.
|
OdiNaturalKeyMember |
findNaturalKeyMemberByAttributeName(java.lang.String name)
Find a natural key member with the specified name.
|
OdiDataStore |
getBoundDataStore()
Get the bound data store for this level.
|
OdiDataStore |
getBoundStagingDataStore()
Get the bound staging data store for this level.
|
java.lang.String |
getDescription()
Get the text description for this level.
|
OdiDimension |
getDimension()
Get the Owning Dimension for this level.
|
java.io.Serializable |
getInternalId() |
java.util.List |
getLevelAttributes()
Get the list of level attributes that are owned by this level.
|
java.lang.Number |
getLevelId()
Get the unique id for this level.
|
java.lang.String |
getName()
Get the name for this level.
|
java.util.List |
getNaturalKeyMembers()
Get the ordered list of natural key member objects owned by this level.
|
java.util.List |
getOrderedNaturalKeyMembers()
Get the list of natural key member objects owned by this level, sorted by display order.
|
java.util.List |
getParentRefs()
Get the list of parent ref objects associated with this level.
|
int |
getPosition()
Get the display position number for this level.
|
OdiLevelAttribute |
getSCD2CurrentFlagAttribute()
Get the level attribute that is acting as the SCD type 2 current flag level attribute.
|
OdiLevelAttribute |
getSCD2EndDateAttribute()
Get the SCD type 2 end date attribute.
|
OdiLevelAttribute |
getSCD2StartDateAttribute()
Get the SCD type 2 start date attribute.
|
java.util.List |
getSCD2TriggerAttributes()
Get the list of SCD type 2 trigger level attributes, by name.
|
IRepositoryEntity |
getSecurityContainer() |
OdiLevelAttribute |
getSurrogateKeyAttribute()
Get the surrogate key level attribute.
|
void |
moveLevelAttributeAfter(OdiLevelAttribute levelAttr,
OdiLevelAttribute baseLevelAttr)
Reorder the specified level attribute to put it after the specified base level attribute.
|
void |
removeLevelAttribute(OdiLevelAttribute levelAttr)
Remove the specified level attribute from this level.
|
void |
removeNaturalKeyMember(OdiNaturalKeyMember member) |
void |
removeParentRef(OdiParentRef pRef)
Remove a parent reference object from this level.
|
void |
resetParentRefKeyMember(boolean value) |
void |
setBoundDataStore(OdiDataStore ds)
Set the bound data store for this level.
|
void |
setBoundStagingDataStore(OdiDataStore stageTable)
Set the bound staging data store for this level.
|
void |
setDescription(java.lang.String desc)
Set a text description for this level.
|
void |
setName(java.lang.String levelName)
Set the name for this level.
|
void |
setNaturalKeyAttributes(java.lang.String[] keyAttrNames)
Set a set of level attributes as natural key attributes, by name.
|
void |
setSCD2CurrentFlagAttribute(OdiLevelAttribute levelAttr)
Set the specified attribute as an SCD type 2 current flag.
|
void |
setSCD2CurrentFlagAttribute(java.lang.String attrName)
Set the specified attribute as an SCD type 2 current flag, by name.
|
void |
setSCD2EndDateAttribute(OdiLevelAttribute levelAttr)
Set the specified attribute as an SCD type 2 end date attribute.
|
void |
setSCD2EndDateAttribute(java.lang.String attrName)
Set the specified attribute as an SCD type 2 end date attribute, by name.
|
void |
setSCD2StartDateAttribute(OdiLevelAttribute levelAttr)
Set the specified attribute as an SCD type 2 start date attribute.
|
void |
setSCD2StartDateAttribute(java.lang.String attrName)
Set the specified attribute as an SCD type 2 start date attribute, by name.
|
void |
setSCD2TriggerAttribute(OdiLevelAttribute levelAttr)
Set the specified attribute as an SCD type 2 trigger attribute.
|
void |
setSCD2TriggerAttribute(java.lang.String attrName)
Set the specified attribute as an SCD type 2 trigger attribute, by name.
|
void |
setSurrogateKeyAttribute(OdiLevelAttribute surrogateKeyAttr)
Get the surrogate key level attribute.
|
void |
setSurrogateKeyAttribute(java.lang.String keyAttrName)
A convenience method to set the surrogate key attribute by name.
|
java.lang.String |
toString() |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
getBigNumericId, getGlobalId, getNumericId
public OdiLevel(OdiDimension owningDim, java.lang.String levelName)
owningDim
- The owning dimension for this level.levelName
- The level name.public OdiLevel(OdiDimension owningDim, OdiLevel baseLevel, java.lang.String levelName)
owningDim
- The owning dimension for this level.baseLevel
- The base Level.levelName
- The level name.public void setName(java.lang.String levelName)
ILevel
public java.lang.String getName()
ILevel
getName
in interface ILevel
getName
in interface IModelObject
public void setDescription(java.lang.String desc)
ILevel
setDescription
in interface ILevel
desc
- The text description to set.public java.lang.String getDescription()
ILevel
getDescription
in interface ILevel
public java.io.Serializable getInternalId()
public java.lang.Number getLevelId()
public IRepositoryEntity getSecurityContainer()
public OdiDimension getDimension()
ILevel
getDimension
in interface ILevel
public java.util.List getParentRefs()
ILevel
getParentRefs
in interface ILevel
public void addParentRef(OdiParentRef pRef)
pRef
- The parent ref object to add.public void removeParentRef(OdiParentRef pRef)
ILevel
removeParentRef
in interface ILevel
pRef
- The parent reference object to remove.public java.util.List getLevelAttributes()
ILevel
getLevelAttributes
in interface ILevel
public void addLevelAttribute(OdiLevelAttribute levelAttr)
levelAttr
- The LevelAttribute
to be added.public void moveLevelAttributeAfter(OdiLevelAttribute levelAttr, OdiLevelAttribute baseLevelAttr)
moveLevelAttributeAfter
in interface ILevel
levelAttr
- The level to reorder.baseLevelAttr
- The base level. If null, the reordered level will be put first.public void removeLevelAttribute(OdiLevelAttribute levelAttr)
ILevel
removeLevelAttribute
in interface ILevel
levelAttr
- The level attribute to be removed.public OdiLevelAttribute getSurrogateKeyAttribute()
ILevel
getSurrogateKeyAttribute
in interface ILevel
public void setSurrogateKeyAttribute(OdiLevelAttribute surrogateKeyAttr)
ILevel
setSurrogateKeyAttribute
in interface ILevel
surrogateKeyAttr
- the SurrogateKey to setpublic void setSurrogateKeyAttribute(java.lang.String keyAttrName) throws java.lang.Exception
ILevel
setSurrogateKeyAttribute
in interface ILevel
keyAttrName
- The name of the level attribute to set as the surrogate key attribute. If no matching
level attribute is found, an exception is thrown.java.lang.Exception
public void resetParentRefKeyMember(boolean value)
value
- public OdiLevelAttribute findLevelAttribute(java.lang.String name)
ILevel
findLevelAttribute
in interface ILevel
name
- The name to match.public OdiNaturalKeyMember findNaturalKeyMemberByAttributeName(java.lang.String name)
ILevel
findNaturalKeyMemberByAttributeName
in interface ILevel
name
- The name to matchpublic void setNaturalKeyAttributes(java.lang.String[] keyAttrNames) throws java.lang.Exception
ILevel
setNaturalKeyAttributes
in interface ILevel
keyAttrNames
- A set of level attribute names used to find a set of level attributes
that will be set as the natural key attributes. If any of the names are not found, then
an exception is thrown.java.lang.Exception
public java.util.List getNaturalKeyMembers()
ILevel
getNaturalKeyMembers
in interface ILevel
public java.util.List getOrderedNaturalKeyMembers()
ILevel
getOrderedNaturalKeyMembers
in interface ILevel
public void addNaturalKeyMember(OdiLevelAttribute levelAttr)
ILevel
addNaturalKeyMember
in interface ILevel
levelAttr
- The level attribute to add as a natural key member. The new natural
key member will be appended to the existing list of members.public void addNaturalKeyMember(OdiNaturalKeyMember keyMember)
levelAttr
- The level attribute to add as a natural key member. The new natural
key member will be appended to the existing list of members.public void removeNaturalKeyMember(OdiNaturalKeyMember member)
public void setSCD2TriggerAttribute(OdiLevelAttribute levelAttr)
ILevel
setSCD2TriggerAttribute
in interface ILevel
levelAttr
- The level attribute to be set as an SCD2 trigger.public void setSCD2TriggerAttribute(java.lang.String attrName) throws java.lang.Exception
ILevel
setSCD2TriggerAttribute
in interface ILevel
attrName
- The name of a level attribute to be set as an SCD2 trigger. If no matching
level attribute is found, an exception is thrown.java.lang.Exception
public void setSCD2StartDateAttribute(OdiLevelAttribute levelAttr)
ILevel
setSCD2StartDateAttribute
in interface ILevel
levelAttr
- The level attribute to be set as an SCD2 start date.public void setSCD2StartDateAttribute(java.lang.String attrName) throws java.lang.Exception
ILevel
setSCD2StartDateAttribute
in interface ILevel
attrName
- The name of a level attribute to be set as an SCD2 trigger. If no
matching level attribute is found, an exception is thrown.java.lang.Exception
public void setSCD2EndDateAttribute(OdiLevelAttribute levelAttr)
ILevel
setSCD2EndDateAttribute
in interface ILevel
levelAttr
- The level attribute to be set as an SCD2 end date.public void setSCD2EndDateAttribute(java.lang.String attrName) throws java.lang.Exception
ILevel
setSCD2EndDateAttribute
in interface ILevel
attrName
- The name of a level attribute to be set as an SCD2 end date. If no matching
level attribute is found, an exception is thrown.java.lang.Exception
public void setSCD2CurrentFlagAttribute(java.lang.String attrName) throws java.lang.Exception
ILevel
setSCD2CurrentFlagAttribute
in interface ILevel
attrName
- The name of a level attribute to be set as an SCD2 current flag. If no matching
level attribute is found, an exception is thrown.java.lang.Exception
public void setSCD2CurrentFlagAttribute(OdiLevelAttribute levelAttr)
ILevel
setSCD2CurrentFlagAttribute
in interface ILevel
levelAttr
- The name of a level attribute to be set as an SCD2 current flag. If no matching
level attribute is found, an exception is thrown.public OdiLevelAttribute getSCD2StartDateAttribute()
ILevel
getSCD2StartDateAttribute
in interface ILevel
public OdiLevelAttribute getSCD2EndDateAttribute()
ILevel
getSCD2EndDateAttribute
in interface ILevel
public OdiLevelAttribute getSCD2CurrentFlagAttribute()
ILevel
getSCD2CurrentFlagAttribute
in interface ILevel
public java.util.List getSCD2TriggerAttributes()
ILevel
getSCD2TriggerAttributes
in interface ILevel
public OdiDataStore getBoundDataStore()
ILevel
getBoundDataStore
in interface ILevel
public OdiDataStore getBoundStagingDataStore()
ILevel
getBoundStagingDataStore
in interface ILevel
public void setBoundStagingDataStore(OdiDataStore stageTable)
ILevel
setBoundStagingDataStore
in interface ILevel
stageTable
- The bound staging datastore to be set.public void setBoundDataStore(OdiDataStore ds)
ILevel
setBoundDataStore
in interface ILevel
ds
- The bound datastore to be set.public int getPosition()
ILevel
getPosition
in interface ILevel
public java.lang.String toString()