com.ibm.xtools.mmi.core.ref

Class StructuredReference

java.lang.Object

com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

com.ibm.xtools.mmi.core.ref.StructuredReference

public final class StructuredReference
extends com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

Structured reference can be used to represent any domain element in terms of properties. The provider id of the StructuredReference is used to locate the IStructuredReferenceProvider.

Supporting Structured References of the StructuredReference can be used to build a relation between Structured References.

See Also:

IStructuredReferenceProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StructuredReference.StructuredReferenceIterator A StructuredReference may contain supporting StructuredReference objects.

Nested classes/interfaces inherited from class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference.InternalStructuredReferenceIterator, com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference.StructuredReference6_0Parser, com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference.StructuredReferenceParser

Field Summary

Fields inherited from class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

props, serializedForm, supportingStructuredReferences

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj) An obj is equal to this, if and only if its object instances are equal or its an instanceof StructuredReference with same handlerId, same props and same supportingStructuredReferences.
protected static com.ibm.xtools.mmi.core.internal.ref.IStructuredReferenceFactory	getFactory()
java.lang.String[]	getProperties() Returns an array of all the properties for this StructuredReference.
java.lang.String	getProperty(java.lang.String name) Returns the value of a specified property for this StructuredReference.
java.lang.String	getProviderId() Returns the id of the provider managing this StructuredReference
StructuredReference	getSupportingStructuredReference(int index) Return the supporting StructuredReference at the specified index.
int	getSupportingStructuredReferenceCount() Return the number of supporting StructuredReferences.
StructuredReference[]	getSupportingStructuredReferences() Returns an array of Supporting StructuredReferences.
int	hashCode() Hashcode of a StructuredReference is defined as sum of hash of handlerId, props and supportingStructuredReferences.
static void	init()
java.lang.String	toString() Returns the serialized form of this StructuredReference

Methods inherited from class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

equalsFastCompareSupportingRefs, getIsolatedCopy, getSerializedForm, internalGetSupportingStructuredReference, internalReplaceSupportingStructuredReference, isolatedFromString, isolatedFromString6_0, memoryOptimizedFromString, setFactory, setSerializedForm

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getFactory

protected static com.ibm.xtools.mmi.core.internal.ref.IStructuredReferenceFactory getFactory()

init

public static void init()

getSupportingStructuredReferences

public StructuredReference[] getSupportingStructuredReferences()

Returns an array of Supporting StructuredReferences.

Returns:

array of supporting StructuredReferences

getSupportingStructuredReference

public StructuredReference getSupportingStructuredReference(int index)

Return the supporting StructuredReference at the specified index.

Parameters:

index - Index of the supporting StructuredReference

Returns:

the requested supporting StructuredReference.

Throws:

java.lang.ArrayIndexOutOfBoundsException - if specified index is out of bounds

getProperties

public java.lang.String[] getProperties()

Returns an array of all the properties for this StructuredReference.

Overrides:

getProperties in class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

Returns:

array of names of the properties for this StructuredReference

getProperty

public java.lang.String getProperty(java.lang.String name)

Returns the value of a specified property for this StructuredReference.

Overrides:

getProperty in class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

Parameters:

name - Name of the property

Returns:

value of the property for a given name or null if this property doesn't exist in the StructuredReference

getSupportingStructuredReferenceCount

public int getSupportingStructuredReferenceCount()

Return the number of supporting StructuredReferences.

Overrides:

getSupportingStructuredReferenceCount in class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

Returns:

the number of supporting StructuredReferences

getProviderId

public java.lang.String getProviderId()

Returns the id of the provider managing this StructuredReference

Overrides:

getProviderId in class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

Returns:

ID of the Provider of this StructuredReference.

toString

public java.lang.String toString()

Description copied from class: com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

Returns the serialized form of this StructuredReference

Overrides:

toString in class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

See Also:

Object.toString()

equals

public boolean equals(java.lang.Object obj)

Description copied from class: com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

An obj is equal to this, if and only if its object instances are equal or its an instanceof StructuredReference with same handlerId, same props and same supportingStructuredReferences.

Overrides:

equals in class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

See Also:

Object.equals(java.lang.Object)

hashCode

public int hashCode()

Description copied from class: com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

Hashcode of a StructuredReference is defined as sum of hash of handlerId, props and supportingStructuredReferences.

Overrides:

hashCode in class com.ibm.xtools.mmi.core.internal.ref.InternalStructuredReference

See Also:

Object.hashCode()