com.revolsys.data.record

Interface Record

All Superinterfaces:

Comparable<Record>, Identifiable, Map<String,Object>

All Known Subinterfaces:

LayerRecord

All Known Implementing Classes:

AbstractLayerRecord, AbstractProxyLayerRecord, AbstractRecord, ArrayLayerRecord, ArrayRecord, BaseRecord, FixedValueRecord, IdentifierProxyLayerRecord, LoadingRecord, NewProxyLayerRecord, OsmElement, OsmNode, OsmProxyLayerRecord, OsmRelation, OsmWay

public interface Record
extends Map<String,Object>, Comparable<Record>, Identifiable

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Method Summary

Methods

Modifier and Type	Method and Description
Record	clone() Create a clone of the data object.
void	delete()
Byte	getByte(CharSequence name)
Double	getDouble(CharSequence name)
RecordFactory	getFactory() Get the factory which created the instance.
String	getFieldTitle(String fieldName)
Float	getFloat(CharSequence name)
<T extends Geometry> T	getGeometryValue() Get the value of the primary geometry attribute.
Identifier	getIdentifier(List<String> fieldNames)
Identifier	getIdentifier(String... fieldNames)
<T> T	getIdValue() Get the value of the unique identifier attribute.
Integer	getInteger(CharSequence name)
Long	getLong(CharSequence name)
RecordDefinition	getRecordDefinition() Get the meta data describing the Record and it's attributes.
Short	getShort(CharSequence name)
RecordState	getState()
String	getString(CharSequence name)
String	getTypeName()
<T> T	getValue(CharSequence name) Get the value of the attribute with the specified name.
<T> T	getValue(int index) Get the value of the attribute with the specified index.
<T> T	getValueByPath(CharSequence attributePath)
Map<String,Object>	getValueMap(Collection<? extends CharSequence> fieldNames)
List<Object>	getValues() Get the values of all attributes.
boolean	hasField(CharSequence name) Checks to see if the definition for this Record has an attribute with the specified name.
boolean	hasValue(CharSequence name)
boolean	hasValuesAny(String... fieldNames) Check if any of the fields have a value.
boolean	isModified()
boolean	isValid(int index)
boolean	isValid(String fieldName)
void	setGeometryValue(Geometry geometry) Set the value of the primary geometry attribute.
void	setIdentifier(Identifier identifier)
void	setIdValue(Object id) Set the value of the unique identifier attribute.
void	setState(RecordState state)
void	setValue(CharSequence name, Object value) Set the value of the attribute with the specified name.
void	setValue(int index, Object value) Set the value of the attribute with the specified name.
void	setValueByPath(CharSequence attributePath, Object value)
<T> T	setValueByPath(CharSequence attributePath, Record source, String sourceAttributePath)
void	setValues(Map<String,? extends Object> values)
void	setValues(Map<String,Object> record, Collection<String> fieldNames)
void	setValues(Map<String,Object> record, String... fieldNames)
void	setValues(Record object)
void	setValuesByPath(Map<String,? extends Object> values) Set the values on the object based on the values in the map.

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface com.revolsys.data.identifier.Identifiable

getIdentifier

Method Detail

clone

Record clone()

Create a clone of the data object.

Returns:

The data object.

delete

void delete()

getByte

Byte getByte(CharSequence name)

getDouble

Double getDouble(CharSequence name)

getFactory

RecordFactory getFactory()

Get the factory which created the instance.

Returns:

The factory.

getFieldTitle

String getFieldTitle(String fieldName)

getFloat

Float getFloat(CharSequence name)

getGeometryValue

<T extends Geometry> T getGeometryValue()

Get the value of the primary geometry attribute.

Returns:

The primary geometry.

getIdentifier

Identifier getIdentifier(List<String> fieldNames)

getIdentifier

Identifier getIdentifier(String... fieldNames)

getIdValue

<T> T getIdValue()

Get the value of the unique identifier attribute.

Returns:

The unique identifier.

getInteger

Integer getInteger(CharSequence name)

getLong

Long getLong(CharSequence name)

getRecordDefinition

RecordDefinition getRecordDefinition()

Get the meta data describing the Record and it's attributes.

Returns:

The meta data.

getShort

Short getShort(CharSequence name)

getState

RecordState getState()

getString

String getString(CharSequence name)

getTypeName

String getTypeName()

getValue

<T> T getValue(CharSequence name)

Get the value of the attribute with the specified name.

Parameters:

name - The name of the attribute.

Returns:

The attribute value.

getValue

<T> T getValue(int index)

Get the value of the attribute with the specified index.

Parameters:

index - The index of the attribute.

Returns:

The attribute value.

getValueByPath

<T> T getValueByPath(CharSequence attributePath)

getValueMap

Map<String,Object> getValueMap(Collection<? extends CharSequence> fieldNames)

getValues

List<Object> getValues()

Get the values of all attributes.

Returns:

The attribute value.

hasField

boolean hasField(CharSequence name)

Checks to see if the definition for this Record has an attribute with the specified name.

Parameters:

name - The name of the attribute.

Returns:

True if the Record has an attribute with the specified name.

hasValue

boolean hasValue(CharSequence name)

hasValuesAny

boolean hasValuesAny(String... fieldNames)

Check if any of the fields have a value.

Parameters:

fieldNames -

Returns:

True if any of the fields have a value, false otherwise.

isModified

boolean isModified()

isValid

boolean isValid(int index)

isValid

boolean isValid(String fieldName)

setGeometryValue

void setGeometryValue(Geometry geometry)

Set the value of the primary geometry attribute.

Parameters:

geometry - The primary geometry.

setIdentifier

void setIdentifier(Identifier identifier)

setIdValue

void setIdValue(Object id)

Set the value of the unique identifier attribute.

Parameters:

id - The unique identifier.

setState

void setState(RecordState state)

setValue

void setValue(CharSequence name,
            Object value)

Set the value of the attribute with the specified name.

Parameters:

name - The name of the attribute. param value The attribute value.

value - The new value;

setValue

void setValue(int index,
            Object value)

Set the value of the attribute with the specified name.

Parameters:

index - The index of the attribute. param value The attribute value.

value - The new value;

setValueByPath

void setValueByPath(CharSequence attributePath,
                  Object value)

setValueByPath

<T> T setValueByPath(CharSequence attributePath,
                   Record source,
                   String sourceAttributePath)

setValues

void setValues(Map<String,? extends Object> values)

setValues

void setValues(Map<String,Object> record,
             Collection<String> fieldNames)

setValues

void setValues(Map<String,Object> record,
             String... fieldNames)

setValues

void setValues(Record object)

setValuesByPath

void setValuesByPath(Map<String,? extends Object> values)

Set the values on the object based on the values in the map.

Parameters:

values - The values to set.