com.revolsys.data.record.schema

Class FieldDefinition

java.lang.Object

com.revolsys.io.AbstractObjectWithProperties

com.revolsys.data.record.schema.FieldDefinition

All Implemented Interfaces:

MapSerializer, ObjectWithProperties, Cloneable

Direct Known Subclasses:

JdbcFieldDefinition

public class FieldDefinition
extends AbstractObjectWithProperties
implements Cloneable, MapSerializer

The FieldDefinition class defines the name, type and other properties about each attribute on a Record in the RecordDefinition.

Author:

Paul Austin

See Also:

Record, RecordDefinition

Constructor Summary

Constructors

Constructor and Description
FieldDefinition()
FieldDefinition(FieldDefinition attribute)
FieldDefinition(int index)
FieldDefinition(Map<String,Object> properties)
FieldDefinition(String name, DataType type, boolean required) Construct a new attribute.
FieldDefinition(String name, DataType type, boolean required, Map<String,Object> properties) Construct a new attribute.
FieldDefinition(String name, DataType dataType, boolean required, String description)
FieldDefinition(String name, DataType type, int length, boolean required) Construct a new attribute.
FieldDefinition(String name, DataType type, int length, boolean required, Map<String,Object> properties) Construct a new attribute.
FieldDefinition(String name, DataType type, int length, boolean required, String description)
FieldDefinition(String name, DataType type, Integer length, Integer scale, Boolean required) Construct a new attribute.
FieldDefinition(String name, DataType type, Integer length, Integer scale, Boolean required, Map<String,Object> properties) Construct a new attribute.
FieldDefinition(String name, DataType type, Integer length, Integer scale, Boolean required, String description) Construct a new attribute.
FieldDefinition(String name, DataType type, Integer length, Integer scale, Boolean required, String description, Map<String,Object> properties) Construct a new attribute.

Method Summary

Methods

Modifier and Type	Method and Description
void	addAllowedValue(Object value, Object text)
void	appendType(StringBuilder string)
FieldDefinition	clone()
<V> V	convert(Object value)
static FieldDefinition	create(Map<String,Object> properties)
boolean	equals(Object object)
Map<Object,Object>	getAllowedValues()
CodeTable	getCodeTable()
<T> T	getDefaultValue()
String	getDescription()
int	getIndex()
int	getLength() Get the maximum length of the attribute value.
int	getMaxStringLength()
<V> V	getMaxValue()
<V> V	getMinValue()
String	getName() Get the name of the attribute.
RecordDefinition	getRecordDefinition()
int	getScale() Get the maximum number of decimal places of the attribute value.
String	getSimpleType()
String	getTitle()
DataType	getType() Get the data type of the attribute value.
Class<?>	getTypeClass() Get the data type class of the attribute value.
String	getTypeDescription() Get the data type of the attribute value.
int	hashCode() Return the hash code of the attribute.
boolean	isRequired() Get the flag indicating if a value is required for the attribute.
void	setAllowedValues(Collection<?> allowedValues)
void	setAllowedValues(Map<?,?> allowedValues)
void	setCodeTable(CodeTable codeTable)
void	setDefaultValue(Object defaultValue)
void	setDescription(String description)
void	setLength(int length)
void	setMaxValue(Object maxValue)
void	setMinValue(Object minValue)
protected void	setRecordDefinition(RecordDefinition recordDefinition)
void	setRequired(boolean required)
void	setScale(int scale)
void	setTitle(String title)
void	setType(DataType type)
void	setValue(Record record, Object value)
Map<String,Object>	toMap() Convert the object to a Map of property name, value pairs.
String	toString()
void	validate(Object value)

Methods inherited from class com.revolsys.io.AbstractObjectWithProperties

clearProperties, close, getProperties, getProperty, getProperty, removeProperty, setProperties, setProperty, setPropertySoft, setPropertyWeak

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldDefinition

public FieldDefinition()

FieldDefinition

public FieldDefinition(FieldDefinition attribute)

FieldDefinition

public FieldDefinition(int index)

FieldDefinition

public FieldDefinition(Map<String,Object> properties)

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               boolean required)

Construct a new attribute.

Parameters:

name - The name of the attribute.

type - The data type of the attribute value.

required - The flag indicating if a value is required for the attribute.

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               boolean required,
               Map<String,Object> properties)

Construct a new attribute.

Parameters:

name - The name of the attribute.

type - The data type of the attribute value.

length - The maximum length of an attribute value, 0 for no maximum.

required - The flag indicating if a value is required for the attribute.

properties - The meta data properties about the attribute.

FieldDefinition

public FieldDefinition(String name,
               DataType dataType,
               boolean required,
               String description)

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               int length,
               boolean required)

Construct a new attribute.

Parameters:

name - The name of the attribute.

type - The data type of the attribute value.

length - The maximum length of an attribute value, 0 for no maximum.

required - The flag indicating if a value is required for the attribute.

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               int length,
               boolean required,
               Map<String,Object> properties)

Construct a new attribute.

Parameters:

name - The name of the attribute.

type - The data type of the attribute value.

length - The maximum length of an attribute value, 0 for no maximum.

scale - The maximum number of decimal places.

required - The flag indicating if a value is required for the attribute.

properties - The meta data properties about the attribute.

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               int length,
               boolean required,
               String description)

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               Integer length,
               Integer scale,
               Boolean required)

Construct a new attribute.

Parameters:

name - The name of the attribute.

type - The data type of the attribute value.

required - The flag indicating if a value is required for the attribute.

properties - The meta data properties about the attribute.

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               Integer length,
               Integer scale,
               Boolean required,
               Map<String,Object> properties)

Construct a new attribute.

Parameters:

name - The name of the attribute.

type - The data type of the attribute value.

length - The maximum length of an attribute value, 0 for no maximum.

scale - The maximum number of decimal places.

required - The flag indicating if a value is required for the attribute.

properties - The meta data properties about the attribute.

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               Integer length,
               Integer scale,
               Boolean required,
               String description)

Construct a new attribute.

Parameters:

name - The name of the attribute.

type - The data type of the attribute value.

length - The maximum length of an attribute value, 0 for no maximum.

scale - The maximum number of decimal places.

required - The flag indicating if a value is required for the attribute.

properties - The meta data properties about the attribute.

FieldDefinition

public FieldDefinition(String name,
               DataType type,
               Integer length,
               Integer scale,
               Boolean required,
               String description,
               Map<String,Object> properties)

Construct a new attribute.

Parameters:

name - The name of the attribute.

type - The data type of the attribute value.

length - The maximum length of an attribute value, 0 for no maximum.

scale - The maximum number of decimal places.

required - The flag indicating if a value is required for the attribute.

properties - The meta data properties about the attribute.

Method Detail

create

public static FieldDefinition create(Map<String,Object> properties)

addAllowedValue

public void addAllowedValue(Object value,
                   Object text)

appendType

public void appendType(StringBuilder string)

clone

public FieldDefinition clone()

Overrides:

clone in class Object

convert

public <V> V convert(Object value)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

getAllowedValues

public Map<Object,Object> getAllowedValues()

getCodeTable

public CodeTable getCodeTable()

getDefaultValue

public <T> T getDefaultValue()

getDescription

public String getDescription()

getIndex

public int getIndex()

getLength

public int getLength()

Get the maximum length of the attribute value. The length 0 should be used if there is no maximum.

Returns:

The maximum length of an attribute value.

getMaxStringLength

public int getMaxStringLength()

getMaxValue

public <V> V getMaxValue()

getMinValue

public <V> V getMinValue()

getName

public String getName()

Get the name of the attribute.

Returns:

The name of the attribute.

getRecordDefinition

public RecordDefinition getRecordDefinition()

getScale

public int getScale()

Get the maximum number of decimal places of the attribute value.

Returns:

The maximum number of decimal places.

getSimpleType

public String getSimpleType()

getTitle

public String getTitle()

getType

public DataType getType()

Get the data type of the attribute value.

Returns:

The data type of the attribute value.

getTypeClass

public Class<?> getTypeClass()

Get the data type class of the attribute value.

Returns:

The data type of the attribute value.

getTypeDescription

public String getTypeDescription()

Get the data type of the attribute value.

Returns:

The data type of the attribute value.

hashCode

public int hashCode()

Return the hash code of the attribute.

Overrides:

hashCode in class Object

Returns:

The hash code.

isRequired

public boolean isRequired()

Get the flag indicating if a value is required for the attribute.

Returns:

True if a value is required, false otherwise.

setAllowedValues

public void setAllowedValues(Collection<?> allowedValues)

setAllowedValues

public void setAllowedValues(Map<?,?> allowedValues)

setCodeTable

public void setCodeTable(CodeTable codeTable)

setDefaultValue

public void setDefaultValue(Object defaultValue)

setDescription

public void setDescription(String description)

setLength

public void setLength(int length)

setMaxValue

public void setMaxValue(Object maxValue)

setMinValue

public void setMinValue(Object minValue)

setRecordDefinition

protected void setRecordDefinition(RecordDefinition recordDefinition)

setRequired

public void setRequired(boolean required)

setScale

public void setScale(int scale)

setTitle

public void setTitle(String title)

setType

public void setType(DataType type)

setValue

public void setValue(Record record,
            Object value)

toMap

public Map<String,Object> toMap()

Description copied from interface: MapSerializer

Convert the object to a Map of property name, value pairs. The values can be one of the following supported types. Other values should be converted to one of these values.

• boolean or Boolean
• byte or Byte
• short or Short
• int or Integer
• long or Long
• float or Float
• double or Double
• String
• Number subclasses
• Collection of supported values
• Map of supported values
• null

Specified by:

toMap in interface MapSerializer

Returns:

toString

public String toString()

Overrides:

toString in class Object

validate

public void validate(Object value)