com.revolsys.data.record.schema

Class RecordDefinitionImpl

java.lang.Object

com.revolsys.io.AbstractObjectWithProperties

com.revolsys.data.record.schema.AbstractRecordStoreSchemaElement

com.revolsys.data.record.schema.RecordDefinitionImpl

All Implemented Interfaces:

RecordDefinition, RecordStoreSchemaElement, MapSerializer, ObjectWithProperties, Comparable<RecordStoreSchemaElement>

public class RecordDefinitionImpl
extends AbstractRecordStoreSchemaElement
implements RecordDefinition

Constructor Summary

Constructors

Constructor and Description
RecordDefinitionImpl()
RecordDefinitionImpl(Map<String,Object> properties)
RecordDefinitionImpl(RecordDefinition recordDefinition)
RecordDefinitionImpl(RecordStoreSchema schema, RecordDefinition recordDefinition)
RecordDefinitionImpl(RecordStoreSchema schema, String path)
RecordDefinitionImpl(RecordStoreSchema schema, String path, Map<String,Object> properties, List<FieldDefinition> fields)
RecordDefinitionImpl(String path)
RecordDefinitionImpl(String path, FieldDefinition... fields)
RecordDefinitionImpl(String path, List<FieldDefinition> fields)
RecordDefinitionImpl(String path, Map<String,Object> properties, FieldDefinition... fields)
RecordDefinitionImpl(String path, Map<String,Object> properties, List<FieldDefinition> fields)

Method Summary

Methods

Modifier and Type	Method and Description
void	addColumnCodeTable(String column, CodeTable codeTable)
void	addDefaultValue(String fieldName, Object defaultValue)
void	addField(FieldDefinition field)
FieldDefinition	addField(String fieldName, DataType type) Adds an field with the given case-sensitive name.
FieldDefinition	addField(String name, DataType type, boolean required)
FieldDefinition	addField(String name, DataType type, int length, boolean required)
FieldDefinition	addField(String name, DataType type, int length, int scale, boolean required)
void	addRestriction(String fieldPath, Collection<Object> values)
void	addSuperClass(RecordDefinition superClass)
void	cloneProperties(Map<String,Object> properties)
static RecordDefinitionImpl	create(Map<String,Object> properties)
Record	createRecord()
void	delete(Record record)
void	destroy()
static void	destroy(RecordDefinitionImpl... recordDefinitionList)
CodeTable	getCodeTableByColumn(String column)
Object	getDefaultValue(String fieldName)
Map<String,Object>	getDefaultValues()
String	getDescription()
FieldDefinition	getField(CharSequence name)
FieldDefinition	getField(int i)
Class<?>	getFieldClass(CharSequence name)
Class<?>	getFieldClass(int i)
int	getFieldCount() Get the number of fields supported by the type.
int	getFieldIndex(CharSequence name) Get the index of the named field within the list of fields for the type.
int	getFieldLength(int i) Get the maximum length of the field.
String	getFieldName(int i) Get the name of the field at the specified index.
List<String>	getFieldNames() Get the names of all the fields supported by the type.
List<FieldDefinition>	getFields()
int	getFieldScale(int i) Get the maximum number of decimal places of the field
String	getFieldTitle(String fieldName)
List<String>	getFieldTitles()
DataType	getFieldType(CharSequence name)
DataType	getFieldType(int i) Get the type name of the field at the specified index.
GeometryFactory	getGeometryFactory()
FieldDefinition	getGeometryField()
int	getGeometryFieldIndex() Get the index of the primary Geometry field.
List<Integer>	getGeometryFieldIndexes() Get the index of all Geometry fields.
String	getGeometryFieldName() Get the name of the primary Geometry field.
List<String>	getGeometryFieldNames() Get the name of the all Geometry fields.
FieldDefinition	getIdField()
int	getIdFieldIndex() Get the index of the Unique identifier field.
List<Integer>	getIdFieldIndexes() Get the index of all ID fields.
String	getIdFieldName() Get the name of the Unique identifier field.
List<String>	getIdFieldNames() Get the name of the all ID fields.
List<FieldDefinition>	getIdFields()
int	getInstanceId()
static RecordDefinition	getRecordDefinition(int instanceId)
RecordDefinitionFactory	getRecordDefinitionFactory()
RecordFactory	getRecordFactory()
Map<String,Collection<Object>>	getRestrictions()
boolean	hasField(CharSequence name) Check to see if the type has the specified field name.
boolean	isFieldDefinition(CharSequence name)
boolean	isFieldDefinition(int i) Return true if a value for the field is required.
boolean	isInstanceOf(RecordDefinition classDefinition)
RecordDefinitionImpl	rename(String path)
void	replaceField(FieldDefinition field, FieldDefinition newFieldDefinition)
void	setCodeTableByColumnMap(Map<String,CodeTable> codeTableByColumnMap)
void	setDefaultValues(Map<String,? extends Object> defaultValues)
void	setDescription(String description)
void	setGeometryFactory(GeometryFactory geometryFactory)
void	setGeometryFieldIndex(int geometryFieldDefinitionIndex)
void	setGeometryFieldName(String name)
void	setIdFieldIndex(int idFieldDefinitionIndex)
void	setIdFieldName(String name)
void	setIdFieldNames(Collection<String> names)
void	setIdFieldNames(String... names)
void	setProperties(Map<String,? extends Object> properties)
void	setRecordDefinitionFactory(RecordDefinitionFactory recordDefinitionFactory)
Map<String,Object>	toMap() Convert the object to a Map of property name, value pairs.

Methods inherited from class com.revolsys.data.record.schema.AbstractRecordStoreSchemaElement

close, compareTo, equalPath, equals, getName, getPath, getRecordStore, getSchema, hashCode, toString

Methods inherited from class com.revolsys.io.AbstractObjectWithProperties

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.revolsys.data.record.schema.RecordStoreSchemaElement

equalPath, getName, getPath, getRecordStore, getSchema

Methods inherited from interface com.revolsys.io.ObjectWithProperties

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

Methods inherited from interface java.lang.Comparable

compareTo

Constructor Detail

RecordDefinitionImpl

public RecordDefinitionImpl()

RecordDefinitionImpl

public RecordDefinitionImpl(Map<String,Object> properties)

RecordDefinitionImpl

public RecordDefinitionImpl(RecordDefinition recordDefinition)

RecordDefinitionImpl

public RecordDefinitionImpl(RecordStoreSchema schema,
                    RecordDefinition recordDefinition)

RecordDefinitionImpl

public RecordDefinitionImpl(RecordStoreSchema schema,
                    String path)

RecordDefinitionImpl

public RecordDefinitionImpl(RecordStoreSchema schema,
                    String path,
                    Map<String,Object> properties,
                    List<FieldDefinition> fields)

RecordDefinitionImpl

public RecordDefinitionImpl(String path)

RecordDefinitionImpl

public RecordDefinitionImpl(String path,
                    FieldDefinition... fields)

RecordDefinitionImpl

public RecordDefinitionImpl(String path,
                    List<FieldDefinition> fields)

RecordDefinitionImpl

public RecordDefinitionImpl(String path,
                    Map<String,Object> properties,
                    FieldDefinition... fields)

RecordDefinitionImpl

public RecordDefinitionImpl(String path,
                    Map<String,Object> properties,
                    List<FieldDefinition> fields)

Method Detail

create

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

destroy

public static void destroy(RecordDefinitionImpl... recordDefinitionList)

getRecordDefinition

public static RecordDefinition getRecordDefinition(int instanceId)

addColumnCodeTable

public void addColumnCodeTable(String column,
                      CodeTable codeTable)

addDefaultValue

public void addDefaultValue(String fieldName,
                   Object defaultValue)

Specified by:

addDefaultValue in interface RecordDefinition

addField

public void addField(FieldDefinition field)

addField

public FieldDefinition addField(String fieldName,
                       DataType type)

Adds an field with the given case-sensitive name.

addField

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

addField

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

addField

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

addRestriction

public void addRestriction(String fieldPath,
                  Collection<Object> values)

addSuperClass

public void addSuperClass(RecordDefinition superClass)

cloneProperties

public void cloneProperties(Map<String,Object> properties)

createRecord

public Record createRecord()

Specified by:

createRecord in interface RecordDefinition

delete

public void delete(Record record)

Specified by:

delete in interface RecordDefinition

destroy

@PreDestroy
public void destroy()

Specified by:

destroy in interface RecordDefinition

getCodeTableByColumn

public CodeTable getCodeTableByColumn(String column)

Specified by:

getCodeTableByColumn in interface RecordDefinition

getDefaultValue

public Object getDefaultValue(String fieldName)

Specified by:

getDefaultValue in interface RecordDefinition

getDefaultValues

public Map<String,Object> getDefaultValues()

Specified by:

getDefaultValues in interface RecordDefinition

getDescription

public String getDescription()

getField

public FieldDefinition getField(CharSequence name)

Specified by:

getField in interface RecordDefinition

getField

public FieldDefinition getField(int i)

Specified by:

getField in interface RecordDefinition

getFieldClass

public Class<?> getFieldClass(CharSequence name)

Specified by:

getFieldClass in interface RecordDefinition

getFieldClass

public Class<?> getFieldClass(int i)

Specified by:

getFieldClass in interface RecordDefinition

getFieldCount

public int getFieldCount()

Description copied from interface: RecordDefinition

Get the number of fields supported by the type.

Specified by:

getFieldCount in interface RecordDefinition

Returns:

The number of fieldibutes.

getFieldIndex

public int getFieldIndex(CharSequence name)

Description copied from interface: RecordDefinition

Get the index of the named field within the list of fields for the type.

Specified by:

getFieldIndex in interface RecordDefinition

Parameters:

name - The field name.

Returns:

The index.

getFieldLength

public int getFieldLength(int i)

Description copied from interface: RecordDefinition

Get the maximum length of the field.

Specified by:

getFieldLength in interface RecordDefinition

Parameters:

i - The field index.

Returns:

The maximum length.

getFieldName

public String getFieldName(int i)

Description copied from interface: RecordDefinition

Get the name of the field at the specified index.

Specified by:

getFieldName in interface RecordDefinition

Parameters:

i - The field index.

Returns:

The field name.

getFieldNames

public List<String> getFieldNames()

Description copied from interface: RecordDefinition

Get the names of all the fields supported by the type.

Specified by:

getFieldNames in interface RecordDefinition

Returns:

The field names.

getFields

public List<FieldDefinition> getFields()

Specified by:

getFields in interface RecordDefinition

getFieldScale

public int getFieldScale(int i)

Description copied from interface: RecordDefinition

Get the maximum number of decimal places of the field

Specified by:

getFieldScale in interface RecordDefinition

Parameters:

i - The field index.

Returns:

The maximum number of decimal places.

getFieldTitle

public String getFieldTitle(String fieldName)

Specified by:

getFieldTitle in interface RecordDefinition

getFieldTitles

public List<String> getFieldTitles()

Specified by:

getFieldTitles in interface RecordDefinition

getFieldType

public DataType getFieldType(CharSequence name)

Specified by:

getFieldType in interface RecordDefinition

getFieldType

public DataType getFieldType(int i)

Description copied from interface: RecordDefinition

Get the type name of the field at the specified index.

Specified by:

getFieldType in interface RecordDefinition

Parameters:

i - The field index.

Returns:

The field type name.

getGeometryFactory

public GeometryFactory getGeometryFactory()

Specified by:

getGeometryFactory in interface RecordDefinition

getGeometryField

public FieldDefinition getGeometryField()

Specified by:

getGeometryField in interface RecordDefinition

getGeometryFieldIndex

public int getGeometryFieldIndex()

Description copied from interface: RecordDefinition

Get the index of the primary Geometry field.

Specified by:

getGeometryFieldIndex in interface RecordDefinition

Returns:

The primary geometry index.

getGeometryFieldIndexes

public List<Integer> getGeometryFieldIndexes()

Description copied from interface: RecordDefinition

Get the index of all Geometry fields.

Specified by:

getGeometryFieldIndexes in interface RecordDefinition

Returns:

The geometry indexes.

getGeometryFieldName

public String getGeometryFieldName()

Description copied from interface: RecordDefinition

Get the name of the primary Geometry field.

Specified by:

getGeometryFieldName in interface RecordDefinition

Returns:

The primary geometry name.

getGeometryFieldNames

public List<String> getGeometryFieldNames()

Description copied from interface: RecordDefinition

Get the name of the all Geometry fields.

Specified by:

getGeometryFieldNames in interface RecordDefinition

Returns:

The geometry names.

getIdField

public FieldDefinition getIdField()

Specified by:

getIdField in interface RecordDefinition

getIdFieldIndex

public int getIdFieldIndex()

Description copied from interface: RecordDefinition

Get the index of the Unique identifier field.

Specified by:

getIdFieldIndex in interface RecordDefinition

Returns:

The unique id index.

getIdFieldIndexes

public List<Integer> getIdFieldIndexes()

Description copied from interface: RecordDefinition

Get the index of all ID fields.

Specified by:

getIdFieldIndexes in interface RecordDefinition

Returns:

The ID indexes.

getIdFieldName

public String getIdFieldName()

Description copied from interface: RecordDefinition

Get the name of the Unique identifier field.

Specified by:

getIdFieldName in interface RecordDefinition

Returns:

The unique id name.

getIdFieldNames

public List<String> getIdFieldNames()

Description copied from interface: RecordDefinition

Get the name of the all ID fields.

Specified by:

getIdFieldNames in interface RecordDefinition

Returns:

The id names.

getIdFields

public List<FieldDefinition> getIdFields()

Specified by:

getIdFields in interface RecordDefinition

getInstanceId

public int getInstanceId()

Specified by:

getInstanceId in interface RecordDefinition

getRecordDefinitionFactory

public RecordDefinitionFactory getRecordDefinitionFactory()

Specified by:

getRecordDefinitionFactory in interface RecordDefinition

getRecordFactory

public RecordFactory getRecordFactory()

Specified by:

getRecordFactory in interface RecordDefinition

getRestrictions

public Map<String,Collection<Object>> getRestrictions()

hasField

public boolean hasField(CharSequence name)

Description copied from interface: RecordDefinition

Check to see if the type has the specified field name.

Specified by:

hasField in interface RecordDefinition

Parameters:

name - The name of the field.

Returns:

True id the type has the field, false otherwise.

isFieldDefinition

public boolean isFieldDefinition(CharSequence name)

Specified by:

isFieldDefinition in interface RecordDefinition

isFieldDefinition

public boolean isFieldDefinition(int i)

Description copied from interface: RecordDefinition

Return true if a value for the field is required.

Specified by:

isFieldDefinition in interface RecordDefinition

Parameters:

i - The field index.

Returns:

True if the field is required, false otherwise.

isInstanceOf

public boolean isInstanceOf(RecordDefinition classDefinition)

Specified by:

isInstanceOf in interface RecordDefinition

rename

public RecordDefinitionImpl rename(String path)

replaceField

public void replaceField(FieldDefinition field,
                FieldDefinition newFieldDefinition)

setCodeTableByColumnMap

public void setCodeTableByColumnMap(Map<String,CodeTable> codeTableByColumnMap)

setDefaultValues

public void setDefaultValues(Map<String,? extends Object> defaultValues)

Specified by:

setDefaultValues in interface RecordDefinition

setDescription

public void setDescription(String description)

setGeometryFactory

public void setGeometryFactory(GeometryFactory geometryFactory)

Specified by:

setGeometryFactory in interface RecordDefinition

setGeometryFieldIndex

public void setGeometryFieldIndex(int geometryFieldDefinitionIndex)

Parameters:

geometryFieldDefinitionIndex - the geometryFieldDefinitionIndex to set

setGeometryFieldName

public void setGeometryFieldName(String name)

setIdFieldIndex

public void setIdFieldIndex(int idFieldDefinitionIndex)

Parameters:

idFieldDefinitionIndex - the idFieldDefinitionIndex to set

setIdFieldName

public void setIdFieldName(String name)

setIdFieldNames

public void setIdFieldNames(Collection<String> names)

setIdFieldNames

public void setIdFieldNames(String... names)

setProperties

public void setProperties(Map<String,? extends Object> properties)

Specified by:

setProperties in interface ObjectWithProperties

Overrides:

setProperties in class AbstractObjectWithProperties

setRecordDefinitionFactory

public void setRecordDefinitionFactory(RecordDefinitionFactory recordDefinitionFactory)

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: