org.apache.ojb.broker.metadata

Class SuperReferenceDescriptor

java.lang.Object

org.apache.ojb.broker.metadata.AttributeDescriptorBase

org.apache.ojb.broker.metadata.ObjectReferenceDescriptor

org.apache.ojb.broker.metadata.SuperReferenceDescriptor

All Implemented Interfaces:

java.io.Serializable, AttributeContainer, RepositoryElements, XmlCapable

public class SuperReferenceDescriptor
extends ObjectReferenceDescriptor

This class handle inheritance as 1-1 association based on a anonymous field (no field in persistent object needed).

Version:

$Id: SuperReferenceDescriptor.java 365232 2005-12-21 22:36:07Z tomdz $

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SuperReferenceDescriptor.SuperReferenceField

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	SUPER_FIELD_INTERNAL_NAME
static java.lang.String	SUPER_FIELD_NAME

Fields inherited from class org.apache.ojb.broker.metadata.ObjectReferenceDescriptor

CASCADE_LINK, CASCADE_NONE, CASCADE_OBJECT

Fields inherited from interface org.apache.ojb.broker.metadata.RepositoryElements

_NEXT, ACCEPT_LOCKS, ACCESS, ATTRIBUTE, ATTRIBUTE_NAME, ATTRIBUTE_VALUE, AUTO_DELETE, AUTO_INCREMENT, AUTO_RETRIEVE, AUTO_UPDATE, BATCH_MODE, CASCADE_LINK_STR, CASCADE_NONE_STR, CASCADE_OBJECT_STR, CLASS_DESCRIPTOR, CLASS_EXTENT, CLASS_NAME, CLASS_PROXY, CLASS_REF, COLLECTION_CLASS, COLLECTION_DESCRIPTOR, COLUMN_NAME, CON_LOG_ABANDONED, CON_MAX_ACTIVE, CON_MAX_IDLE, CON_MAX_WAIT, CON_MIN_EVICTABLE_IDLE_TIME_MILLIS, CON_NUM_TESTS_PER_EVICTION_RUN, CON_REMOVE_ABANDONED, CON_REMOVE_ABANDONED_TIMEOUT, CON_TEST_ON_BORROW, CON_TEST_ON_RETURN, CON_TEST_WHILE_IDLE, CON_TIME_BETWEEN_EVICTION_RUNS_MILLIS, CON_WHEN_EXHAUSTED_ACTION, CONNECTION_FACTORY, CONNECTION_POOL, CONSTANT_ARGUMENT, DATASOURCE_NAME, DBMS_NAME, DEFAULT_CONNECTION, DELETE_PROCEDURE, DOCUMENTATION, DRIVER_NAME, EAGER_RELEASE, EXTENDS, FACTORY_CLASS, FACTORY_METHOD, FIELD_CONVERSION, FIELD_DESCRIPTOR, FIELD_ID_REF, FIELD_NAME, FIELD_REF, FK_POINTING_TO_ITEMS_CLASS, FK_POINTING_TO_THIS_CLASS, FOREIGN_KEY, ID, IGNORE_AUTOCOMMIT_EXCEPTION, INCLUDE_ALL_FIELDS, INCLUDE_PK_FIELDS_ONLY, INDEX_COLUMN, INDEX_DESCRIPTOR, INDEXED, INDIRECTION_TABLE, INITIALIZATION_METHOD, INSERT_PROCEDURE, INVERSE_FK, ISOLATION_LEVEL, ITEMS_CLASS, JCD_ALIAS, JDBC_CONNECTION_DESCRIPTOR, JDBC_LEVEL, JDBC_TYPE, LENGTH, LOCKING, MAPPING_REPOSITORY, NAME, NULLABLE, OBJECT_CACHE, ORDERBY, OTM_DEPENDENT, PRECISION, PRIMARY_KEY, PROXY_PREFETCHING_LIMIT, PROXY_REFERENCE, QUERY_CUSTOMIZER, REFERENCE_DESCRIPTOR, REFERENCED_CLASS, REFRESH, REPOSITORY_VERSION, RETURN, RETURN_FIELD_REF, ROW_READER, RUNTIME_ARGUMENT, SCALE, SCHEMA_NAME, SEQUENCE_MANAGER, SEQUENCE_MANAGER_CLASS, SEQUENCE_NAME, SORT, TABLE_NAME, TAG_ACCESS, TAG_ACCESS_ANONYMOUS, TAG_ACCESS_READONLY, TAG_ACCESS_READWRITE, TAG_SUPER, UNIQUE, UPDATE_LOCK, UPDATE_PROCEDURE, URL_DBALIAS, URL_PROTOCOL, URL_SUBPROTOCOL, USE_AUTOCOMMIT, USER_NAME, USER_PASSWD, VALIDATION_QUERY, VALUE

Constructor Summary

Constructors

Constructor and Description
SuperReferenceDescriptor(ClassDescriptor descriptor)

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(java.lang.String attributeName, java.lang.String attributeValue) Store the specified attribute and it's value.
java.lang.String	getAttribute(java.lang.String attributeName) Get the value of an attribute
java.lang.String	getAttribute(java.lang.String attributeName, java.lang.String defaultValue) Get the value of an attribute
java.lang.String[]	getAttributeNames() Returns an array of the names of all atributes of this descriptor.
java.util.Map	getAttributes() Returns the attribute map (name, value) of this descriptor.
SuperReferenceDescriptor.SuperReferenceField	getInheritanceField()
boolean	isJavaInheritance() If this method returns true the inheritance described by this object is a normal JAVA inheritance.
boolean	isSuperReferenceDescriptor() Returns true if this descriptor was used to describe a reference to a super class of an object.
void	setCascadeDelete(boolean cascade)
void	setCascadeRetrieve(boolean b)
void	setCascadeStore(boolean cascade)
void	setCascadingDelete(int cascade)
void	setCascadingDelete(java.lang.String value)
void	setCascadingStore(int cascade)
void	setCascadingStore(java.lang.String value)
void	setItemClass(java.lang.Class c) sets the item class
void	setLazy(boolean lazy) Sets the lazy.
void	setPersistentField(java.lang.Class c, java.lang.String fieldname) Noop, a specific PersistentField is used internal - SuperReferenceDescriptor.SuperReferenceField.
void	setPersistentField(PersistentField pf) Noop, a specific PersistentField is used internal - SuperReferenceDescriptor.SuperReferenceField.

Methods inherited from class org.apache.ojb.broker.metadata.ObjectReferenceDescriptor

addForeignKeyField, addForeignKeyField, getCascadeAsString, getCascadeDelete, getCascadeRetrieve, getCascadeStore, getCascadingDelete, getCascadingStore, getForeignKeyFieldDescriptors, getForeignKeyFields, getForeignKeyValues, getItemClass, getItemClassName, getItemProxyClass, getOtmDependent, getProxyPrefetchingLimit, hasConstraint, isLazy, isRefresh, setConstraint, setForeignKeyFields, setOtmDependent, setProxyPrefetchingLimit, setRefresh, toString, toXML

Methods inherited from class org.apache.ojb.broker.metadata.AttributeDescriptorBase

getAttributeName, getClassDescriptor, getPersistentField, setClassDescriptor

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

SUPER_FIELD_INTERNAL_NAME

public static final java.lang.String SUPER_FIELD_INTERNAL_NAME

See Also:

Constant Field Values

SUPER_FIELD_NAME

public static final java.lang.String SUPER_FIELD_NAME

See Also:

Constant Field Values

Constructor Detail

SuperReferenceDescriptor

public SuperReferenceDescriptor(ClassDescriptor descriptor)

Method Detail

isSuperReferenceDescriptor

public boolean isSuperReferenceDescriptor()

Description copied from class: ObjectReferenceDescriptor

Returns true if this descriptor was used to describe a reference to a super class of an object.

Overrides:

isSuperReferenceDescriptor in class ObjectReferenceDescriptor

Returns:

always false for this instance.

setItemClass

public void setItemClass(java.lang.Class c)

Description copied from class: ObjectReferenceDescriptor

sets the item class

Overrides:

setItemClass in class ObjectReferenceDescriptor

Parameters:

c - the items class object

setPersistentField

public void setPersistentField(java.lang.Class c,
                      java.lang.String fieldname)

Noop, a specific PersistentField is used internal - SuperReferenceDescriptor.SuperReferenceField.

Overrides:

setPersistentField in class AttributeDescriptorBase

setPersistentField

public void setPersistentField(PersistentField pf)

Noop, a specific PersistentField is used internal - SuperReferenceDescriptor.SuperReferenceField.

Overrides:

setPersistentField in class AttributeDescriptorBase

setLazy

public void setLazy(boolean lazy)

Description copied from class: ObjectReferenceDescriptor

Sets the lazy.

Overrides:

setLazy in class ObjectReferenceDescriptor

Parameters:

lazy - The lazy to set

setCascadeRetrieve

public void setCascadeRetrieve(boolean b)

Overrides:

setCascadeRetrieve in class ObjectReferenceDescriptor

setCascadingStore

public void setCascadingStore(int cascade)

Overrides:

setCascadingStore in class ObjectReferenceDescriptor

setCascadingStore

public void setCascadingStore(java.lang.String value)

Overrides:

setCascadingStore in class ObjectReferenceDescriptor

setCascadingDelete

public void setCascadingDelete(int cascade)

Overrides:

setCascadingDelete in class ObjectReferenceDescriptor

setCascadingDelete

public void setCascadingDelete(java.lang.String value)

Overrides:

setCascadingDelete in class ObjectReferenceDescriptor

setCascadeStore

public void setCascadeStore(boolean cascade)

Overrides:

setCascadeStore in class ObjectReferenceDescriptor

setCascadeDelete

public void setCascadeDelete(boolean cascade)

Overrides:

setCascadeDelete in class ObjectReferenceDescriptor

getInheritanceField

public SuperReferenceDescriptor.SuperReferenceField getInheritanceField()

isJavaInheritance

public boolean isJavaInheritance()

If this method returns true the inheritance described by this object is a normal JAVA inheritance. If false the inheritance is only declared in the O/R mapping it's a declarative inheritance, the referenced "super class" in not a JAVA super class of the main class.

addAttribute

public void addAttribute(java.lang.String attributeName,
                java.lang.String attributeValue)

Description copied from interface: AttributeContainer

Store the specified attribute and it's value.

Specified by:

addAttribute in interface AttributeContainer

Parameters:

attributeName - the name of the attribute to retrieve

attributeValue - the attribute's value

See Also:

AttributeContainer.addAttribute(String, String)

getAttribute

public java.lang.String getAttribute(java.lang.String attributeName,
                            java.lang.String defaultValue)

Description copied from interface: AttributeContainer

Get the value of an attribute

Specified by:

getAttribute in interface AttributeContainer

Parameters:

attributeName - the attribute to retrieve

defaultValue - the value to return if the attribute is not present

Returns:

the attribute value

See Also:

AttributeContainer.getAttribute(String, String)

getAttribute

public java.lang.String getAttribute(java.lang.String attributeName)

Description copied from interface: AttributeContainer

Get the value of an attribute

Specified by:

getAttribute in interface AttributeContainer

Parameters:

attributeName - the attribute to retrieve

Returns:

the attribute value

See Also:

AttributeContainer.getAttribute(String)

getAttributes

public java.util.Map getAttributes()

Returns the attribute map (name, value) of this descriptor. Note that the returned map is not modifiable.

Returns:

The attributes

getAttributeNames

public java.lang.String[] getAttributeNames()

Returns an array of the names of all atributes of this descriptor.

Returns:

The list of attribute names (will not be null)