org.jpox.metadata
Class InheritanceMetaData

java.lang.Object
  org.jpox.metadata.MetaData
      org.jpox.metadata.ExtendableMetaData
          org.jpox.metadata.InheritanceMetaData

All Implemented Interfaces:

java.io.Serializable

public class InheritanceMetaData
extends ExtendableMetaData

Representation of the Meta-Data defining inherited classes.

MetaData Element

The MetaData element represented here is as follows

 <!ELEMENT inheritance (extension*, join?, discriminator?, extension*)?>
 <!ATTLIST inheritance strategy CDATA #IMPLIED>
 

Since:

1.1

Version:

$Revision: 1.5 $

See Also:

Serialized Form

Field Summary

protected DiscriminatorMetaData	discriminatorMetaData DiscriminatorMetaData element.
protected JoinMetaData	joinMetaData JoinMetaData element.
protected InheritanceStrategy	strategy strategy tag value.

Fields inherited from class org.jpox.metadata.ExtendableMetaData

extensions, JPOX_VENDOR_NAME

Fields inherited from class org.jpox.metadata.MetaData

LOCALISER, METADATA_CREATED_STATE, METADATA_INITIALISED_STATE, METADATA_POPULATED_STATE, METADATA_USED_STATE, metaDataState, parent

Constructor Summary

InheritanceMetaData(AbstractClassMetaData parent, java.lang.String strategy)
Constructor.AbstractClassMetaData

Method Summary

DiscriminatorMetaData	getDiscriminatorMetaData() Accessor for the Discrimintor MetaData.
JoinMetaData	getJoinMetaData() Accessor for the Join MetaData.
InheritanceStrategy	getStrategyValue() Accessor for the strategy tag value
void	initialise() Method to initialise the object, creating internal convenience arrays.
void	setDiscriminatorMetaData(DiscriminatorMetaData discriminatorMetaData) Mutator for the Discriminator MetaData.
void	setJoinMetaData(JoinMetaData joinMetaData) Mutator for the Join MetaData.
java.lang.String	toString() Accessor for a string representation of the object.
java.lang.String	toString(java.lang.String prefix, java.lang.String indent) Returns a string representation of the object using a prefix

Methods inherited from class org.jpox.metadata.ExtendableMetaData

addExtension, addExtension, getExtension, getExtensions, getNoOfExtensions, getValueForExtension, getValuesForExtension, getValuesForExtensionStartingWith, hasExtension, removeExtension

Methods inherited from class org.jpox.metadata.MetaData

getParent, isCreated, isInitialised, isPopulated, isUsed, populate, setInitialised, setPopulated, setUsed

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

strategy

protected InheritanceStrategy strategy

strategy tag value.

joinMetaData

protected JoinMetaData joinMetaData

JoinMetaData element.

discriminatorMetaData

protected DiscriminatorMetaData discriminatorMetaData

DiscriminatorMetaData element.

Constructor Detail

InheritanceMetaData

public InheritanceMetaData(AbstractClassMetaData parent,
                           java.lang.String strategy)

Constructor.AbstractClassMetaData

Parameters:

parent - parent ClassMetaData instance

strategy - Inheritance strategy

Method Detail

initialise

public void initialise()

Method to initialise the object, creating internal convenience arrays. Initialises all sub-objects.

Overrides:

initialise in class MetaData

getStrategyValue

public InheritanceStrategy getStrategyValue()

Accessor for the strategy tag value

Returns:

strategy tag value

getJoinMetaData

public JoinMetaData getJoinMetaData()

Accessor for the Join MetaData.

Returns:

Returns the joinMetaData.

setJoinMetaData

public void setJoinMetaData(JoinMetaData joinMetaData)

Mutator for the Join MetaData.

Parameters:

joinMetaData - The joinMetaData to set.

getDiscriminatorMetaData

public DiscriminatorMetaData getDiscriminatorMetaData()

Accessor for the Discrimintor MetaData.

Returns:

Returns the Discrimintor MetaData.

setDiscriminatorMetaData

public void setDiscriminatorMetaData(DiscriminatorMetaData discriminatorMetaData)

Mutator for the Discriminator MetaData.

Parameters:

discriminatorMetaData - The discriminatorMetaData to set.

toString

public java.lang.String toString()

Accessor for a string representation of the object.

Overrides:

toString in class ExtendableMetaData

Returns:

a string representation of the object.

toString

public java.lang.String toString(java.lang.String prefix,
                                 java.lang.String indent)

Returns a string representation of the object using a prefix

Overrides:

toString in class ExtendableMetaData

Parameters:

prefix - prefix string

indent - indent string

Returns:

a string representation of the object.