org.apache.jackrabbit.ocm.mapper.model
Class CollectionDescriptor

java.lang.Object
  org.apache.jackrabbit.ocm.mapper.model.CollectionDescriptor

All Implemented Interfaces:

ChildNodeDefDescriptor, PropertyDefDescriptor

public class CollectionDescriptor
extends Object
implements ChildNodeDefDescriptor, PropertyDefDescriptor

CollectionDescriptor is used by the mapper to read general information on a collection field

Author:

Lombart Christophe

Constructor Summary

CollectionDescriptor()

Method Summary

ClassDescriptor	getClassDescriptor()
String	getCollectionClassName()
String	getCollectionConverter()
String	getDefaultPrimaryType()
String	getElementClassName()
String	getFieldName()
String	getJcrElementName()
String	getJcrName()
String	getJcrOnParentVersion() Getter for property jcrOnParentVersion.
String	getJcrType() Getter for property jcrType.
boolean	isAutoInsert()
boolean	isAutoRetrieve()
boolean	isAutoUpdate()
boolean	isJcrAutoCreated() Getter for property jcrAutoCreated.
boolean	isJcrMandatory() Getter for property jcrMandatory.
boolean	isJcrMultiple() Getter for property jcrMultiple.
boolean	isJcrProtected() Getter for property jcrProtected.
boolean	isJcrSameNameSiblings() Getter for property jcrSameNameSiblings.
boolean	isProxy()
void	setAutoInsert(boolean autoInsert)
void	setAutoRetrieve(boolean autoRetrieve)
void	setAutoUpdate(boolean autoUpdate)
void	setClassDescriptor(ClassDescriptor classDescriptor) Set the associated class descriptor
void	setCollectionClassName(String collectionClassName) Set the collection class name.
void	setCollectionConverter(String collectionConverterClassName) Set the collection converter class name
void	setDefaultPrimaryType(String defaultPrimaryType)
void	setElementClassName(String elementClassName)
void	setFieldName(String fieldName)
void	setJcrAutoCreated(boolean value) Setter for property jcrAutoCreated.
void	setJcrElementName(String jcrElementName)
void	setJcrMandatory(boolean value) Setter for property jcrMandatory.
void	setJcrMultiple(boolean value) Setter for property jcrMultiple.
void	setJcrName(String jcrName)
void	setJcrOnParentVersion(String value) Setter for property jcrOnParentVersion.
void	setJcrProtected(boolean value) Setter for property jcrProtected.
void	setJcrSameNameSiblings(boolean value) Setter for property jcrSameNameSiblings.
void	setJcrType(String value) Setter for property jcrType.
void	setProxy(boolean proxy)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CollectionDescriptor

public CollectionDescriptor()

Method Detail

getFieldName

public String getFieldName()

Returns:

Returns the fieldName.

setFieldName

public void setFieldName(String fieldName)

Parameters:

fieldName - The fieldName to set.

getJcrName

public String getJcrName()

Specified by:

getJcrName in interface ChildNodeDefDescriptor

Specified by:

getJcrName in interface PropertyDefDescriptor

Returns:

Returns the jcrName.

setJcrName

public void setJcrName(String jcrName)

Parameters:

jcrName - The jcrName to set.

getElementClassName

public String getElementClassName()

Returns:

Returns the elementClassName.

setElementClassName

public void setElementClassName(String elementClassName)

Parameters:

elementClassName - The collection element class name to set.

getJcrElementName

public String getJcrElementName()

Returns:

Returns the elementName.

setJcrElementName

public void setJcrElementName(String jcrElementName)

Parameters:

jcrElementName - The collection element name to set.

isProxy

public boolean isProxy()

Returns:

Returns the proxy.

setProxy

public void setProxy(boolean proxy)

Parameters:

proxy - The proxy to set.

isAutoInsert

public boolean isAutoInsert()

setAutoInsert

public void setAutoInsert(boolean autoInsert)

isAutoRetrieve

public boolean isAutoRetrieve()

setAutoRetrieve

public void setAutoRetrieve(boolean autoRetrieve)

isAutoUpdate

public boolean isAutoUpdate()

setAutoUpdate

public void setAutoUpdate(boolean autoUpdate)

getCollectionConverter

public String getCollectionConverter()

Returns:

The collection converter class name

setCollectionConverter

public void setCollectionConverter(String collectionConverterClassName)

Set the collection converter class name

Parameters:

collectionConverterClassName - The converter to set

getCollectionClassName

public String getCollectionClassName()

Returns:

the collection class name (can be also a Map)

setCollectionClassName

public void setCollectionClassName(String collectionClassName)

Set the collection class name. This collection class has to implement ManageableCollection

Parameters:

collectionClassName - The collection class name to set

getClassDescriptor

public ClassDescriptor getClassDescriptor()

Returns:

The associated class descriptor

setClassDescriptor

public void setClassDescriptor(ClassDescriptor classDescriptor)

Set the associated class descriptor

Parameters:

classDescriptor - the class descriptor to set

getJcrType

public String getJcrType()

Getter for property jcrType.

Specified by:

getJcrType in interface ChildNodeDefDescriptor

Specified by:

getJcrType in interface PropertyDefDescriptor

Returns:

jcrType

setJcrType

public void setJcrType(String value)

Setter for property jcrType.

Parameters:

value - jcrType

isJcrAutoCreated

public boolean isJcrAutoCreated()

Getter for property jcrAutoCreated.

Specified by:

isJcrAutoCreated in interface ChildNodeDefDescriptor

Specified by:

isJcrAutoCreated in interface PropertyDefDescriptor

Returns:

jcrAutoCreated

setJcrAutoCreated

public void setJcrAutoCreated(boolean value)

Setter for property jcrAutoCreated.

Parameters:

value - jcrAutoCreated

isJcrMandatory

public boolean isJcrMandatory()

Getter for property jcrMandatory.

Specified by:

isJcrMandatory in interface ChildNodeDefDescriptor

Specified by:

isJcrMandatory in interface PropertyDefDescriptor

Returns:

jcrMandatory

setJcrMandatory

public void setJcrMandatory(boolean value)

Setter for property jcrMandatory.

Parameters:

value - jcrMandatory

getJcrOnParentVersion

public String getJcrOnParentVersion()

Getter for property jcrOnParentVersion.

Specified by:

getJcrOnParentVersion in interface ChildNodeDefDescriptor

Specified by:

getJcrOnParentVersion in interface PropertyDefDescriptor

Returns:

jcrOnParentVersion

setJcrOnParentVersion

public void setJcrOnParentVersion(String value)

Setter for property jcrOnParentVersion.

Parameters:

value - jcrOnParentVersion

isJcrProtected

public boolean isJcrProtected()

Getter for property jcrProtected.

Specified by:

isJcrProtected in interface ChildNodeDefDescriptor

Specified by:

isJcrProtected in interface PropertyDefDescriptor

Returns:

jcrProtected

setJcrProtected

public void setJcrProtected(boolean value)

Setter for property jcrProtected.

Parameters:

value - jcrProtected

isJcrSameNameSiblings

public boolean isJcrSameNameSiblings()

Getter for property jcrSameNameSiblings.

Specified by:

isJcrSameNameSiblings in interface ChildNodeDefDescriptor

Returns:

jcrSameNameSiblings

setJcrSameNameSiblings

public void setJcrSameNameSiblings(boolean value)

Setter for property jcrSameNameSiblings.

Parameters:

value - jcrSameNameSiblings

isJcrMultiple

public boolean isJcrMultiple()

Getter for property jcrMultiple.

Specified by:

isJcrMultiple in interface PropertyDefDescriptor

Returns:

jcrMultiple

setJcrMultiple

public void setJcrMultiple(boolean value)

Setter for property jcrMultiple.

Parameters:

value - jcrMultiple

toString

public String toString()

Overrides:

toString in class Object

getDefaultPrimaryType

public String getDefaultPrimaryType()

Specified by:

getDefaultPrimaryType in interface ChildNodeDefDescriptor

Returns:

Whether the default not type to use when create new instances of this child

setDefaultPrimaryType

public void setDefaultPrimaryType(String defaultPrimaryType)