org.castor.jdo.jpa.info
Class FieldInfo

java.lang.Object
  extended by org.castor.jdo.jpa.info.FieldInfo
All Implemented Interfaces:
NatureExtendable, PropertyHolder

public class FieldInfo
extends java.lang.Object
implements PropertyHolder

This class holds the necessary information so that Castor can properly map a JPA annotated classes member to the database.

Since:
1.3
Author:
Peter Schmidt

Constructor Summary
FieldInfo(ClassInfo declaringClass, java.lang.Class<?> fieldType, java.lang.String fieldName, FieldHandlerImpl fieldHandler)
          Creates a FieldInfo associated to the given ClassInfo, describing the given a field with the given name using method (property) access.
 
Method Summary
 void addNature(java.lang.String nature)
          Adds a specified nature.
 ClassInfo getDeclaringClassInfo()
          Returns the declaring ClassInfo this FieldInfo is associated with.
 FieldHandlerImpl getFieldHandler()
          Returns the FieldHandler associated with this field.
 java.lang.String getFieldName()
          Indicates the name of the field described by this FieldInfo.
 java.lang.Class<?> getFieldType()
          Indicates the type of the field described by this FieldInfo.
 java.lang.Object getProperty(java.lang.String name)
          Get a property by its name.
 boolean hasNature(java.lang.String nature)
          Checks if a specified nature has been added.
 void setDeclaringClassInfo(ClassInfo classInfo)
          Sets the reference to the declaring ClassInfo this FieldInfo is associated with.
 void setFieldHandler(FieldHandlerImpl fieldHandler)
          Sets the FieldHandler associated with this field.
 void setFieldName(java.lang.String fieldName)
          Sets the name of the field described by this FieldInfo.
 void setFieldType(java.lang.Class<?> fieldType)
          Sets the type of the field described by this FieldInfo.
 void setProperty(java.lang.String name, java.lang.Object value)
          Set a property specified by the name to the passed value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FieldInfo

public FieldInfo(ClassInfo declaringClass,
                 java.lang.Class<?> fieldType,
                 java.lang.String fieldName,
                 FieldHandlerImpl fieldHandler)
Creates a FieldInfo associated to the given ClassInfo, describing the given a field with the given name using method (property) access.

Parameters:
declaringClass - The ClassInfo this FieldInfo is associated with.
fieldType - The type of the described field.
fieldName - The name of the described field.
fieldHandler - The FieldHandlerImpl that describes the accessType of that field.
Method Detail

addNature

public void addNature(java.lang.String nature)
Adds a specified nature.

Specified by:
addNature in interface NatureExtendable
Parameters:
nature - the name of the nature
See Also:
NatureExtendable.addNature(java.lang.String)

hasNature

public boolean hasNature(java.lang.String nature)
Checks if a specified nature has been added.

Specified by:
hasNature in interface NatureExtendable
Parameters:
nature - the name of the nature.
Returns:
true if the specified nature was added.
See Also:
NatureExtendable.hasNature(java.lang.String)

getProperty

public java.lang.Object getProperty(java.lang.String name)
Get a property by its name.

Specified by:
getProperty in interface PropertyHolder
Parameters:
name - the name of the property to get.
Returns:
the property as specified by the name.
See Also:
PropertyHolder.getProperty(java.lang.String)

setProperty

public void setProperty(java.lang.String name,
                        java.lang.Object value)
Set a property specified by the name to the passed value.

Specified by:
setProperty in interface PropertyHolder
Parameters:
name - the name of the property to set.
value - the value to set the specified property to.
See Also:
PropertyHolder.setProperty(java.lang.String, java.lang.Object)

getDeclaringClassInfo

public ClassInfo getDeclaringClassInfo()
Returns the declaring ClassInfo this FieldInfo is associated with.

Returns:
the declaring ClassInfo this FieldInfo is associated with.

setDeclaringClassInfo

public void setDeclaringClassInfo(ClassInfo classInfo)
Sets the reference to the declaring ClassInfo this FieldInfo is associated with.

Parameters:
classInfo - The ClassInfo this FieldInfo is associated with.

getFieldName

public java.lang.String getFieldName()
Indicates the name of the field described by this FieldInfo.

Returns:
the name of the field described by this FieldInfo.

setFieldName

public void setFieldName(java.lang.String fieldName)
Sets the name of the field described by this FieldInfo.

Parameters:
fieldName - set the name of the field described by this FieldInfo.

getFieldType

public java.lang.Class<?> getFieldType()
Indicates the type of the field described by this FieldInfo.

Returns:
the type of the field.

setFieldType

public void setFieldType(java.lang.Class<?> fieldType)
Sets the type of the field described by this FieldInfo.

Parameters:
fieldType - The Type of the field.

getFieldHandler

public FieldHandlerImpl getFieldHandler()
Returns the FieldHandler associated with this field.

Returns:
The FieldHandlerImpl managing access to the underlying field.

setFieldHandler

public void setFieldHandler(FieldHandlerImpl fieldHandler)
Sets the FieldHandler associated with this field.

Parameters:
fieldHandler - the FieldHandlerImpl managing access to the underlying field.


Copyright © 2011. All Rights Reserved.