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

FieldValueDescriptor()

Method Summary

List<TextValue>	getDisplayLabels() The labels to be used for display purposes.
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.
URI	getType() The type of the field value.
void	setDisplayLabels(List<TextValue> displayLabels) The labels to be used for display purposes.
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	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, 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.