org.objectweb.jorm.metainfo.api
Interface ScalarField

All Superinterfaces:
MetaObject, PrimitiveElement, java.io.Serializable, TypedElement

public interface ScalarField
extends PrimitiveElement

A ScalarField describes corresponds to a hidden field of a ClassObject or a Generic Class. For Classes, it is typically used to represent PNames. For Generic Class, it can also be used for the index attributes of the Generic Class.

Author:
X. Spengler

Field Summary
 
Fields inherited from interface org.objectweb.jorm.metainfo.api.PrimitiveElement
CONSTANT_NON_PERSISTENT, CONSTANT_PERSISTENT, VARIABLE_PERSISTENT
 
Method Summary
 java.lang.String getNullValue()
          get the null value for this field.
 java.lang.Object getNullValueObject()
          get the null value for this field
 boolean hasNullValue()
          Test if the null value exists for this field.
 void setNullValue(java.lang.String value)
          Set the null value for this field.
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.PrimitiveElement
getScale, getSize, getStatus, isAutoCalculated, isConstant, isPersistent, isScalar, setIsAutoCalculated, setStatus
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.TypedElement
getName, getType
 
Methods inherited from interface org.objectweb.jorm.metainfo.api.MetaObject
getParent, setParent
 

Method Detail

setNullValue

public void setNullValue(java.lang.String value)
Set the null value for this field.

Parameters:
value - a string representation of the nullvalue

getNullValue

public java.lang.String getNullValue()
get the null value for this field.

Returns:
the string representation of the null value or null if there is no null value for this field.

getNullValueObject

public java.lang.Object getNullValueObject()
get the null value for this field

Returns:
an object representing the null value according to the field type. For instance a null value for a byte scalar field is stored into a java.lang.Byte object.

hasNullValue

public boolean hasNullValue()
Test if the null value exists for this field.

Returns:
true if the null value exist for this field.