|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.adt.topology.provider.impl.TopologyObjectImpl
public class TopologyObjectImpl
TopologyObjectImpl provides a default implementation of TopologyObject that is used in conjunction with the default TopologyProvider implementation. A Provider implementation may choose to use this class directly or may extend it to provide customized function such as querying some backend for related object or property information. In addition to implementing the public APIs defined by TopologyObject, several helper methods are also availble for use by the Provider implementation.
Constructor Summary | |
---|---|
protected |
TopologyObjectImpl(java.lang.String internalId,
java.lang.String displayName,
TopologyObjectType type,
TopologyProviderImpl provider)
Creates a TopologyObjectImpl instance. |
Method Summary | |
---|---|
protected void |
cacheParentObject(TopologyObject object)
Helper method to cache the reference to the parent TopologyObject. |
void |
cacheProperties(PropertyList properties)
Helper method that caches the properties for the TopologyObject. |
protected void |
cacheRelatedObject(TopologyObjectImpl object,
RelationshipMetaInfo relationship)
Helper method to cache the related TopologyObject using the specified relationship. |
protected TopologyObject[] |
getCachedRelatedObjects(RelationshipMetaInfo relationship)
Helper methid to retreive the cached related TopologyObjects for the specified relationship. |
java.lang.String |
getDisplayName()
|
java.lang.String |
getFQName()
|
protected java.lang.String |
getInternalId()
Helper method that returns the internal TopologyObject id. |
protected TopologyObjectType |
getInternalType()
Helper method that returns the TopologyObjectType instance associated with this TopologyObject. |
TopologyObject |
getParent()
|
PropertyList |
getProperties()
|
TopologyProvider |
getProvider()
|
TopologyObject[] |
getRelatedObjects(RelationshipMetaInfo relationship)
|
TopologyObject[] |
getRelatedObjects(RelationshipMetaInfo[] relationships)
|
TopologyObject[] |
getRelatedObjects(RelationshipMetaInfo[] relationships,
TopologyService serviceContext)
|
TopologyObject[] |
getRelatedObjects(RelationshipMetaInfo relationship,
TopologyService serviceContext)
|
RelationshipMetaInfo[] |
getRelationshipsMetaInfo()
|
RelationshipMetaInfo[] |
getRelationshipsMetaInfo(java.lang.String relationshipKey)
|
TopologyObject |
getRoot()
|
java.lang.String |
getType()
|
java.lang.String |
getUniqueId()
|
protected boolean |
relatedObjectsCached(RelationshipMetaInfo relationship)
Helper method to test the "objects cached" indicator for the specified relationship. |
protected void |
setDisplayName(java.lang.String displayName)
Helper method to reset the display name for the object. |
protected void |
setRelatedObjectsCached(RelationshipMetaInfo relationship)
Helper method to set the "objects cached" indicator for the specified relationship. |
protected void |
validateRelationship(RelationshipMetaInfo relationship)
Helper method that validates the RelationshipMetaInfo instance. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
protected TopologyObjectImpl(java.lang.String internalId, java.lang.String displayName, TopologyObjectType type, TopologyProviderImpl provider) throws TopologyException
internalId
- an identifier that uniquely identifies this TopologyObject
within the context of the owning TopologyProviderImpl instancedisplayName
- a name that uniquely names this TopologyObject within it's
composition heirarchytype
- the type of TopologyObject (in TopologyObjectType form)provider
-
TopologyException
Method Detail |
---|
public TopologyObject getParent()
getParent
in interface TopologyObject
public PropertyList getProperties() throws TopologyException
getProperties
in interface TopologyObject
TopologyException
public TopologyObject[] getRelatedObjects(RelationshipMetaInfo relationship) throws TopologyException
getRelatedObjects
in interface TopologyObject
TopologyException
public TopologyObject[] getRelatedObjects(RelationshipMetaInfo[] relationships) throws TopologyException
getRelatedObjects
in interface TopologyObject
TopologyException
public TopologyObject[] getRelatedObjects(RelationshipMetaInfo[] relationships, TopologyService serviceContext) throws TopologyException
getRelatedObjects
in interface TopologyObject
TopologyException
public TopologyObject[] getRelatedObjects(RelationshipMetaInfo relationship, TopologyService serviceContext) throws TopologyException
getRelatedObjects
in interface TopologyObject
TopologyException
public final java.lang.String getDisplayName()
getDisplayName
in interface TopologyObject
public final java.lang.String getFQName() throws TopologyException
getFQName
in interface TopologyObject
TopologyException
public final TopologyProvider getProvider()
getProvider
in interface TopologyObject
public final java.lang.String getType()
getType
in interface TopologyObject
public final java.lang.String getUniqueId()
getUniqueId
in interface TopologyObject
public final TopologyObject getRoot() throws TopologyException
getRoot
in interface TopologyObject
TopologyException
public final RelationshipMetaInfo[] getRelationshipsMetaInfo() throws TopologyException
getRelationshipsMetaInfo
in interface TopologyObject
TopologyException
public final RelationshipMetaInfo[] getRelationshipsMetaInfo(java.lang.String relationshipKey) throws TopologyException
getRelationshipsMetaInfo
in interface TopologyObject
relationshipKey
- in the form of "key=value::key=value::..." where key can be any of
the following: relationshipType, sourceType, label, targetType, isCrossProvider, sourceRole,
targetRole, navigable, uniqueId
TopologyException
public final void cacheProperties(PropertyList properties)
properties
- protected final void validateRelationship(RelationshipMetaInfo relationship) throws TopologyException
relationship
-
TopologyException
protected final java.lang.String getInternalId()
protected final void cacheParentObject(TopologyObject object)
object
- protected final void cacheRelatedObject(TopologyObjectImpl object, RelationshipMetaInfo relationship) throws TopologyException
object
- specifies related object reference to be cachedrelationship
-
TopologyException
protected final void setRelatedObjectsCached(RelationshipMetaInfo relationship)
relationship
- protected final boolean relatedObjectsCached(RelationshipMetaInfo relationship)
relationship
- protected final TopologyObject[] getCachedRelatedObjects(RelationshipMetaInfo relationship)
relationship
-
protected final void setDisplayName(java.lang.String displayName)
displayName
- protected final TopologyObjectType getInternalType()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |