com.metamatrix.metadata.runtime.api
Interface MetadataObject

All Superinterfaces:
java.io.Serializable
All Known Subinterfaces:
DataType, Element, Group, Key, Model, Procedure, VirtualDatabase
All Known Implementing Classes:
BasicElement, BasicGroup, BasicKey, BasicMetadataObject, BasicModel, BasicProcedure, BasicVirtualDatabase

public interface MetadataObject
extends java.io.Serializable


Method Summary
 java.lang.Object clone()
          Return a deep cloned instance of this object.
 int compareTo(java.lang.Object obj)
          Compares this object to another.
 boolean equals(java.lang.Object obj)
          Returns true if the specified object is semantically equal to this instance.
 java.lang.String getFullName()
          Returns the full name for this instance of the object.
 MetadataID getID()
          Return the identifier for this object.
 java.lang.String getName()
          Returns the name for this instance of the object.
 java.util.Properties getProperties()
          returns the user defined properties for this metadata object.
 VirtualDatabaseID getVirtualDatabaseID()
          returns the VirtualDatabaseID that identifies the VirtualDatabase this metadata object resides.
 java.lang.String toString()
          Returns a string representing the current state of the object.
 

Method Detail

getID

MetadataID getID()
Return the identifier for this object. The returned type will be an instance of the BaseID subclass which corresponds to the class of this node.

Returns:
the specialized BaseID instance for this node.

getName

java.lang.String getName()
Returns the name for this instance of the object. If you are using the dot notation for a naming conventions, this will return the last node in name.

Returns:
the name
See Also:
getFullName

getFullName

java.lang.String getFullName()
Returns the full name for this instance of the object.

Returns:
the name

compareTo

int compareTo(java.lang.Object obj)
Compares this object to another. If the specified object is an instance of the same class, then this method compares the name; otherwise, it throws a ClassCastException (as instances are comparable only to instances of the same class). Note: this method is consistent with equals().

Parameters:
obj - the object that this instance is to be compared to.
Returns:
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object, respectively.
Throws:
java.lang.ClassCastException - if the specified object's type prevents it from being compared to this instance.

toString

java.lang.String toString()
Returns a string representing the current state of the object.

Overrides:
toString in class java.lang.Object
Returns:
the string representation of this instance.

equals

boolean equals(java.lang.Object obj)
Returns true if the specified object is semantically equal to this instance. Note: this method is consistent with compareTo().

Overrides:
equals in class java.lang.Object
Parameters:
obj - the object that this instance is to be compared to.
Returns:
whether the object is equal to this object.

clone

java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Return a deep cloned instance of this object. Subclasses must override this method.

Returns:
the object that is the clone of this instance.
Throws:
java.lang.CloneNotSupportedException - if this object cannot be cloned (i.e., only objects in Defaults cannot be cloned).

getVirtualDatabaseID

VirtualDatabaseID getVirtualDatabaseID()
returns the VirtualDatabaseID that identifies the VirtualDatabase this metadata object resides.

Returns:
VirtualDatabaseID

getProperties

java.util.Properties getProperties()
                                   throws VirtualDatabaseException
returns the user defined properties for this metadata object.

Returns:
Properties
Throws:
VirtualDatabaseException


Copyright © 2009. All Rights Reserved.