|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.metamatrix.metadata.runtime.model.BasicMetadataObject
com.metamatrix.metadata.runtime.model.BasicKey
public class BasicKey
Constructor Summary | |
---|---|
BasicKey(BasicKeyID keyID,
BasicVirtualDatabaseID virtualDBID)
Call constructor to instantiate a runtime object by passing the RuntimeID that identifies the entity and the VIrtualDatabaseID that identifes the Virtual Database the object will be contained. |
Method Summary | |
---|---|
void |
addElementID(ElementID elementID)
|
void |
clearElementIDs()
|
java.lang.String |
getAlias()
Return the alias. |
java.lang.String |
getDescription()
Return the description. |
java.util.List |
getElementIDs()
Returns an ordered list of ElementID's this key is made of. |
short |
getKeyType()
Return short indicating the type of key. |
short |
getMatchType()
Return short indicating the type of reference key matching. |
java.lang.String |
getNameInSource()
Override the super method so that when the name is returned, it is the name and not the full path for a key |
java.lang.String |
getPath()
Return the path to the key. |
MetadataID |
getReferencedKey()
|
long |
getReferencedKeyUID()
|
boolean |
isAccessPattern()
Return boolean indicating if this is an access pattern. |
boolean |
isForeignKey()
Return boolean indicating if this key is a foreign key. |
boolean |
isIndexed()
Return boolean indicating if this key is indexed. |
boolean |
isPrimaryKey()
Return boolean indicating if the key is the primary key. |
boolean |
isUniqueKey()
Return boolean indicating if the key is a unique key. |
void |
setAlias(java.lang.String alias)
|
void |
setDescription(java.lang.String description)
|
void |
setElementIDs(java.util.List elements)
|
void |
setIsIndexed(boolean isIndexed)
|
void |
setKeyType(short keyType)
|
void |
setMatchType(short matchType)
|
void |
setPath(java.lang.String path)
|
void |
setReferencedKey(MetadataID referKey)
|
void |
setReferencedKeyUID(long uid)
|
Methods inherited from class com.metamatrix.metadata.runtime.model.BasicMetadataObject |
---|
addProperty, clone, compareTo, equals, getCurrentProperties, getFullName, getID, getName, getProperties, getVirtualDatabaseID, hashCode, hasNameInSource, setID, setProperties, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.metamatrix.metadata.runtime.api.MetadataObject |
---|
clone, compareTo, equals, getFullName, getID, getName, getProperties, getVirtualDatabaseID, toString |
Constructor Detail |
---|
public BasicKey(BasicKeyID keyID, BasicVirtualDatabaseID virtualDBID)
Method Detail |
---|
public java.lang.String getDescription()
Key
getDescription
in interface Key
public java.lang.String getNameInSource()
getNameInSource
in class BasicMetadataObject
public java.lang.String getAlias()
Key
getAlias
in interface Key
getAlias
in class BasicMetadataObject
public void setAlias(java.lang.String alias)
public java.util.List getElementIDs()
Key
getElementIDs
in interface Key
public MetadataID getReferencedKey()
getReferencedKey
in interface Key
public boolean isPrimaryKey()
Key
isPrimaryKey
in interface Key
public boolean isForeignKey()
Key
isForeignKey
in interface Key
public boolean isUniqueKey()
Key
isUniqueKey
in interface Key
public boolean isIndexed()
Key
isIndexed
in interface Key
public boolean isAccessPattern()
Key
isAccessPattern
in interface Key
public short getKeyType()
Key
getKeyType
in interface Key
MetadataConstants.KEY_TYPES
public short getMatchType()
Key
getMatchType
in interface Key
MetadataConstants.MATCH_TYPES
public long getReferencedKeyUID()
public java.lang.String getPath()
Key
getPath
in interface Key
getPath
in class BasicMetadataObject
public void setDescription(java.lang.String description)
public void setIsIndexed(boolean isIndexed)
public void setKeyType(short keyType)
public void setMatchType(short matchType)
public void setReferencedKey(MetadataID referKey)
public void setReferencedKeyUID(long uid)
public void setElementIDs(java.util.List elements)
public void clearElementIDs()
public void setPath(java.lang.String path)
public void addElementID(ElementID elementID)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |