org.gedcomx.records

Class FieldValueDescriptor

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.links.HypermediaEnabledData

org.gedcomx.records.FieldValueDescriptor

All Implemented Interfaces:

HasTransientProperties, SupportsLinks, SupportsExtensionElements

public class FieldValueDescriptor
extends HypermediaEnabledData

A way a field is to be displayed to a user.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor and Description
FieldValueDescriptor()

Method Summary

Modifier and Type	Method and Description
List<TextValue>	getDisplayLabels() The labels to be used for display purposes.
String	getDisplaySortKey() A sort key for sorting this field value relative to other field values according to how they should be displayed for viewing.
Boolean	getEditable() Whether the field value is editable.
List<TextValue>	getEntryLabels() The labels to be used for entry purposes.
Boolean	getEntryRequired() Whether some kind of entry is required when entering data for editing.
String	getEntrySortKey() A sort key for sorting this field value relative to other field values according to how they should be entered for editing.
FieldValueType	getKnownType() The known type of the field value.
String	getLabelId() The id of the label applicable to the field value.
Boolean	getOptional() Whether the treatment of the field value is optional.
String	getParentLabelId() The id of the label for the "parent" field value.
URI	getType() The type of the field value.
void	setDisplayLabels(List<TextValue> displayLabels) The labels to be used for display purposes.
void	setDisplaySortKey(String displaySortKey) A sort key for sorting this field value relative to other field values according to how they should be displayed for viewing.
void	setEditable(Boolean editable) Whether the field value is editable.
void	setEntryLabels(List<TextValue> entryLabels) The labels to be used for entry purposes.
void	setEntryRequired(Boolean entryRequired) Whether some kind of entry is required when entering data for editing.
void	setEntrySortKey(String entrySortKey) A sort key for sorting this field value relative to other field values according to how they should be entered for editing.
void	setKnownType(FieldValueType type) The type of the field value.
void	setLabelId(String labelId) The language of this display information.
void	setOptional(Boolean optional) Whether the treatment of the field value is optional.
void	setParentLabelId(String parentLabelId) The id of the label for the "parent" field value.
void	setType(URI type) The type of the field value.

Methods inherited from class org.gedcomx.links.HypermediaEnabledData

addLink, addLink, addTemplatedLink, embed, getLink, getLinks, getLinks, link, link, setLinks

Methods inherited from class org.gedcomx.common.ExtensibleData

addExtensionElement, embed, extensionElement, findExtensionOfType, findExtensionOfType, findExtensionsOfType, findExtensionsOfType, getExtensionElements, getId, getTransientProperties, getTransientProperty, id, removeExtensionElements, setExtensionElement, setExtensionElements, setId, setTransientProperty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FieldValueDescriptor

public FieldValueDescriptor()

Method Detail

getLabelId

public String getLabelId()

The id of the label applicable to the field value.

Returns:

The id of the label applicable to the field value

setLabelId

public void setLabelId(String labelId)

The language of this display information. See http://www.w3.org/International/articles/language-tags/

Parameters:

labelId - The language of this display information.

getType

public URI getType()

The type of the field value.

Returns:

The type of the field value.

setType

public void setType(URI type)

The type of the field value.

Parameters:

type - The type of the field value.

getKnownType

public FieldValueType getKnownType()

The known type of the field value.

Returns:

The type of the field value.

setKnownType

public void setKnownType(FieldValueType type)

The type of the field value.

Parameters:

type - The type of the field value.

getOptional

public Boolean getOptional()

Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty.

Returns:

Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty.

setOptional

public void setOptional(Boolean optional)

Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty.

Parameters:

optional - Whether the treatment of the field value is optional. Used to determine whether it should be displayed even if the value is empty.

getDisplayLabels

public List<TextValue> getDisplayLabels()

The labels to be used for display purposes.

Returns:

The labels to be used for display purposes.

setDisplayLabels

public void setDisplayLabels(List<TextValue> displayLabels)

The labels to be used for display purposes.

Parameters:

displayLabels - The labels to be used for display purposes.

getEntryLabels

public List<TextValue> getEntryLabels()

The labels to be used for entry purposes.

Returns:

The labels to be used for entry purposes.

setEntryLabels

public void setEntryLabels(List<TextValue> entryLabels)

The labels to be used for entry purposes.

Parameters:

entryLabels - The labels to be used for entry purposes.

getDisplaySortKey

public String getDisplaySortKey()

A sort key for sorting this field value relative to other field values according to how they should be displayed for viewing.

Returns:

A sort key for sorting this field value relative to other field values according to how they should be displayed for viewing.

setDisplaySortKey

public void setDisplaySortKey(String displaySortKey)

A sort key for sorting this field value relative to other field values according to how they should be displayed for viewing.

Parameters:

displaySortKey - A sort key for sorting this field value relative to other field values according to how they should be displayed for viewing.

getEntrySortKey

public String getEntrySortKey()

A sort key for sorting this field value relative to other field values according to how they should be entered for editing.

Returns:

A sort key for sorting this field value relative to other field values according to how they should be entered for editing.

setEntrySortKey

public void setEntrySortKey(String entrySortKey)

A sort key for sorting this field value relative to other field values according to how they should be entered for editing.

Parameters:

entrySortKey - A sort key for sorting this field value relative to other field values according to how they should be entered for editing.

getEntryRequired

public Boolean getEntryRequired()

Whether some kind of entry is required when entering data for editing.

Returns:

Whether some kind of entry is required when entering data for editing.

setEntryRequired

public void setEntryRequired(Boolean entryRequired)

Whether some kind of entry is required when entering data for editing.

Parameters:

entryRequired - Whether some kind of entry is required when entering data for editing.

getEditable

public Boolean getEditable()

Whether the field value is editable. Some field values might be composed from other field values or otherwise calculated by the system.

Returns:

Whether the field value is editable. Some field values might be composed from other field values or otherwise calculated by the system.

setEditable

public void setEditable(Boolean editable)

Whether the field value is editable. Some field values might be composed from other field values or otherwise calculated by the system.

Parameters:

editable - Whether the field value is editable. Some field values might be composed from other field values or otherwise calculated by the system.

getParentLabelId

public String getParentLabelId()

The id of the label for the "parent" field value. For example, the parent field value of a "given name" field value might be the "name" field value.

Returns:

The id of the label for the "parent" field value. For example, the parent field value of a "given name" field value might be the "name" field value.

setParentLabelId

public void setParentLabelId(String parentLabelId)

The id of the label for the "parent" field value. For example, the parent field value of a "given name" field value might be the "name" field value.

Parameters:

parentLabelId - The id of the label for the "parent" field value. For example, the parent field value of a "given name" field value might be the "name" field value.