ojb.broker.metadata
Class CollectionDescriptor

java.lang.Object
  |
  +--ojb.broker.metadata.AttributeDescriptorBase
        |
        +--ojb.broker.metadata.ObjectReferenceDescriptor
              |
              +--ojb.broker.metadata.CollectionDescriptor

All Implemented Interfaces:

java.io.Serializable

public class CollectionDescriptor

extends ObjectReferenceDescriptor

mapping Description for member fields that are Collections

Author:

Thomas Mahler

See Also:

Serialized Form

Constructor Summary

CollectionDescriptor()

Method Summary

java.lang.Class	getCollectionClass() returns the type of the collection.
java.lang.Object[]	getFksToItemClass()
java.lang.Object[]	getFksToThisClass()
java.lang.String	getIndirectionTable()
java.lang.String	getOrderBy() Gets the orderBy.
boolean	isAscending() Gets the orderAscending.
boolean	isLazy() returns true if this is a lazy Collection.
boolean	isMtoNRelation()
boolean	isRefresh() Gets the refresh.
void	setAscending(boolean ascending) Sets the ascending.
void	setCollectionClass(java.lang.Class c) set the type of the collection
void	setFksToItemClass(java.util.Vector fksToItemClass)
void	setFksToThisClass(java.util.Vector fksToThisClass)
void	setIndirectionTable(java.lang.String indirectionTable)
void	setLazy(boolean lazy) Sets the lazy flag.
void	setOrderBy(java.lang.String orderBy) Sets the orderBy.
void	setRefresh(boolean refresh) Sets the refresh.

Methods inherited from class ojb.broker.metadata.ObjectReferenceDescriptor

getCascadeDelete, getCascadeRetrieve, getCascadeStore, getForeignKeyFieldDescriptors, getForeignKeyFields, getForeignKeyValues, getItemClass, getItemProxyClass, setCascadeDelete, setCascadeRetrieve, setCascadeStore, setForeignKeyFields, setItemClass

Methods inherited from class ojb.broker.metadata.AttributeDescriptorBase

getClassDescriptor, getPersistentField, setClassDescriptor, setDebug, setPersistentField

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionDescriptor

public CollectionDescriptor()

Method Detail

getFksToThisClass

public java.lang.Object[] getFksToThisClass()

setFksToThisClass

public void setFksToThisClass(java.util.Vector fksToThisClass)

getCollectionClass

public java.lang.Class getCollectionClass()

returns the type of the collection.

Returns:

java.lang.Class

setCollectionClass

public void setCollectionClass(java.lang.Class c)

set the type of the collection

getIndirectionTable

public java.lang.String getIndirectionTable()

setIndirectionTable

public void setIndirectionTable(java.lang.String indirectionTable)

getFksToItemClass

public java.lang.Object[] getFksToItemClass()

setFksToItemClass

public void setFksToItemClass(java.util.Vector fksToItemClass)

isMtoNRelation

public boolean isMtoNRelation()

getOrderBy

public java.lang.String getOrderBy()

Gets the orderBy.

Returns:

Returns a String

setOrderBy

public void setOrderBy(java.lang.String orderBy)

Sets the orderBy.

Parameters:

orderBy - The orderBy to set

isAscending

public boolean isAscending()

Gets the orderAscending.

Returns:

Returns a boolean

setAscending

public void setAscending(boolean ascending)

Sets the ascending.

Parameters:

ascending - The ascending to set

isLazy

public boolean isLazy()

returns true if this is a lazy Collection.

Overrides:

isLazy in class ObjectReferenceDescriptor

Returns:

Returns a boolean

setLazy

public void setLazy(boolean lazy)

Sets the lazy flag.

Overrides:

setLazy in class ObjectReferenceDescriptor

Parameters:

lazy - The lazy to set

isRefresh

public boolean isRefresh()

Gets the refresh.

Overrides:

isRefresh in class ObjectReferenceDescriptor

Returns:

Returns a boolean

setRefresh

public void setRefresh(boolean refresh)

Sets the refresh.

Overrides:

setRefresh in class ObjectReferenceDescriptor

Parameters:

refresh - The refresh to set