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

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

All Implemented Interfaces:

PropertyDefDescriptor

public class FieldDescriptor
extends Object
implements PropertyDefDescriptor

FieldDescriptor is used by the mapper to read general information on a atomic field

Author:

Lombart Christophe

Constructor Summary

FieldDescriptor()

Method Summary

ClassDescriptor	getClassDescriptor()
String	getConverter()
String	getFieldName()
String	getJcrDefaultValue()
String	getJcrName()
String	getJcrOnParentVersion() Getter for property jcrOnParentVersion.
String	getJcrType() Getter for property jcrType.
String[]	getJcrValueConstraints()
boolean	isId()
boolean	isJcrAutoCreated() Getter for propery jcrAutoCreated.
boolean	isJcrMandatory() Getter for property jcrMandatory.
boolean	isJcrMultiple() Getter for property jcrMultiple.
boolean	isJcrProtected() Getter for property jcrProtected.
boolean	isPath()
boolean	isUuid()
void	setClassDescriptor(ClassDescriptor classDescriptor) Set the associated class descriptor
void	setConverter(String converter) Set the atomic converter
void	setFieldName(String fieldName)
void	setId(boolean id)
void	setJcrAutoCreated(boolean value) Setter for property jcrAutoCreated.
void	setJcrDefaultValue(String defaultValue)
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	setJcrType(String value) Setter for property jcrType.
void	setJcrValueConstraints(String jcrValueConstraints)
void	setJcrValueConstraints(String[] jcrValueConstraints)
void	setPath(boolean path)
void	setUuid(boolean uuid)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldDescriptor

public FieldDescriptor()

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 PropertyDefDescriptor

Returns:

Returns the jcrName.

setJcrName

public void setJcrName(String jcrName)

Parameters:

jcrName - The jcrName to set.

getConverter

public String getConverter()

Returns:

The atomic type converter to use, can be null

setConverter

public void setConverter(String converter)

Set the atomic converter

Parameters:

converter - the atomic converter to use

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

isId

public boolean isId()

Returns:

true if the field is the class ID

setId

public void setId(boolean id)

Parameters:

id -

isPath

public boolean isPath()

Returns:

Returns true if the field is the object JCR path.

setPath

public void setPath(boolean path)

Parameters:

path - The path to set.

isUuid

public boolean isUuid()

Returns:

Returns true if the field is the UUID.

setUuid

public void setUuid(boolean uuid)

Parameters:

path - The path to set.

getJcrType

public String getJcrType()

Getter for property jcrType.

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 propery jcrAutoCreated.

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 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 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 PropertyDefDescriptor

Returns:

jcrProtected

setJcrProtected

public void setJcrProtected(boolean value)

Setter for property jcrProtected.

Parameters:

value - jcrProtected

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

getJcrDefaultValue

public String getJcrDefaultValue()

setJcrDefaultValue

public void setJcrDefaultValue(String defaultValue)

getJcrValueConstraints

public String[] getJcrValueConstraints()

setJcrValueConstraints

public void setJcrValueConstraints(String[] jcrValueConstraints)

setJcrValueConstraints

public void setJcrValueConstraints(String jcrValueConstraints)

toString

public String toString()

Overrides:

toString in class Object