com.revolsys.data.record.schema

Interface RecordDefinition

All Superinterfaces:

Comparable<RecordStoreSchemaElement>, MapSerializer, ObjectWithProperties, RecordStoreSchemaElement

All Known Implementing Classes:

RecordDefinitionImpl

public interface RecordDefinition
extends RecordStoreSchemaElement, MapSerializer

Method Summary

Methods

Modifier and Type	Method and Description
void	addDefaultValue(String fieldName, Object defaultValue)
Record	createRecord()
void	delete(Record record)
void	destroy()
CodeTable	getCodeTableByColumn(String column)
Object	getDefaultValue(String fieldName)
Map<String,Object>	getDefaultValues()
FieldDefinition	getField(CharSequence name)
FieldDefinition	getField(int index)
Class<?>	getFieldClass(CharSequence name)
Class<?>	getFieldClass(int index)
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 index) Get the maximum length of the field.
String	getFieldName(int index) 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 index) Get the maximum number of decimal places of the field
String	getFieldTitle(String fieldName)
List<String>	getFieldTitles()
DataType	getFieldType(CharSequence name)
DataType	getFieldType(int index) 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()
RecordDefinitionFactory	getRecordDefinitionFactory()
RecordFactory	getRecordFactory()
boolean	hasField(CharSequence name) Check to see if the type has the specified field name.
boolean	isFieldDefinition(CharSequence name)
boolean	isFieldDefinition(int index) Return true if a value for the field is required.
boolean	isInstanceOf(RecordDefinition classDefinition)
void	setDefaultValues(Map<String,? extends Object> defaultValues)
void	setGeometryFactory(GeometryFactory geometryFactory)

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, setProperties, setProperty, setPropertySoft, setPropertyWeak

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.revolsys.io.map.MapSerializer

toMap

Method Detail

addDefaultValue

void addDefaultValue(String fieldName,
                   Object defaultValue)

createRecord

Record createRecord()

delete

void delete(Record record)

destroy

void destroy()

getCodeTableByColumn

CodeTable getCodeTableByColumn(String column)

getDefaultValue

Object getDefaultValue(String fieldName)

getDefaultValues

Map<String,Object> getDefaultValues()

getField

FieldDefinition getField(CharSequence name)

getField

FieldDefinition getField(int index)

getFieldClass

Class<?> getFieldClass(CharSequence name)

getFieldClass

Class<?> getFieldClass(int index)

getFieldCount

int getFieldCount()

Get the number of fields supported by the type.

Returns:

The number of fieldibutes.

getFieldIndex

int getFieldIndex(CharSequence name)

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

Parameters:

name - The field name.

Returns:

The index.

getFieldLength

int getFieldLength(int index)

Get the maximum length of the field.

Parameters:

index - The field index.

Returns:

The maximum length.

getFieldName

String getFieldName(int index)

Get the name of the field at the specified index.

Parameters:

index - The field index.

Returns:

The field name.

getFieldNames

List<String> getFieldNames()

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

Returns:

The field names.

getFields

List<FieldDefinition> getFields()

getFieldScale

int getFieldScale(int index)

Get the maximum number of decimal places of the field

Parameters:

index - The field index.

Returns:

The maximum number of decimal places.

getFieldTitle

String getFieldTitle(String fieldName)

getFieldTitles

List<String> getFieldTitles()

getFieldType

DataType getFieldType(CharSequence name)

getFieldType

DataType getFieldType(int index)

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

Parameters:

index - The field index.

Returns:

The field type name.

getGeometryFactory

GeometryFactory getGeometryFactory()

getGeometryField

FieldDefinition getGeometryField()

getGeometryFieldIndex

int getGeometryFieldIndex()

Get the index of the primary Geometry field.

Returns:

The primary geometry index.

getGeometryFieldIndexes

List<Integer> getGeometryFieldIndexes()

Get the index of all Geometry fields.

Returns:

The geometry indexes.

getGeometryFieldName

String getGeometryFieldName()

Get the name of the primary Geometry field.

Returns:

The primary geometry name.

getGeometryFieldNames

List<String> getGeometryFieldNames()

Get the name of the all Geometry fields.

Returns:

The geometry names.

getIdField

FieldDefinition getIdField()

getIdFieldIndex

int getIdFieldIndex()

Get the index of the Unique identifier field.

Returns:

The unique id index.

getIdFieldIndexes

List<Integer> getIdFieldIndexes()

Get the index of all ID fields.

Returns:

The ID indexes.

getIdFieldName

String getIdFieldName()

Get the name of the Unique identifier field.

Returns:

The unique id name.

getIdFieldNames

List<String> getIdFieldNames()

Get the name of the all ID fields.

Returns:

The id names.

getIdFields

List<FieldDefinition> getIdFields()

getInstanceId

int getInstanceId()

getRecordDefinitionFactory

RecordDefinitionFactory getRecordDefinitionFactory()

getRecordFactory

RecordFactory getRecordFactory()

hasField

boolean hasField(CharSequence name)

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

Parameters:

name - The name of the field.

Returns:

True id the type has the field, false otherwise.

isFieldDefinition

boolean isFieldDefinition(CharSequence name)

isFieldDefinition

boolean isFieldDefinition(int index)

Return true if a value for the field is required.

Parameters:

index - The field index.

Returns:

True if the field is required, false otherwise.

isInstanceOf

boolean isInstanceOf(RecordDefinition classDefinition)

setDefaultValues

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

setGeometryFactory

void setGeometryFactory(GeometryFactory geometryFactory)