Package org.gedcomx.records

Class FieldValue

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.links.HypermediaEnabledData

org.gedcomx.conclusion.Conclusion

org.gedcomx.records.FieldValue

All Implemented Interfaces:

Attributable, HasNotes, HasTransientProperties, SupportsLinks, SupportsExtensionElements, ReferencesSources

public final class FieldValue
extends Conclusion

An element representing a value in a record field.

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor	Description
FieldValue()
FieldValue(String text)
FieldValue(FieldValue copy)

Method Summary

Modifier and Type	Method	Description
void	accept(GedcomxModelVisitor visitor)	Accept a visitor.
FieldValue	analysis(ResourceReference analysis)	Add a reference to the analysis for this conclusion.
FieldValue	analysis(URI analysis)	Add a reference to the analysis for this conclusion.
FieldValue	analysis(Document analysis)	Add a reference to the analysis for this conclusion.
FieldValue	attribution(Attribution attribution)	Build up this conclusion with attribution.
FieldValue	confidence(URI confidence)	Build up this conclusion with a confidence level.
FieldValue	confidence(ConfidenceLevel confidence)	Build up this conclusion with a confidence level.
FieldValue	datatype(URI datatype)	Build out this field value with a data type.
boolean	equals(Object o)
FieldValue	extensionElement(Object element)
URI	getDatatype()	The datatype of the text value of the field.
FieldValueStatusType	getKnownStatus()	The known type of the field.
FieldValueType	getKnownType()	The known type of the field value.
String	getLabelId()	The id of the label applicable to this field value.
URI	getResource()	URI that resolves to the value of the field.
URI	getStatus()	The status of this FieldValue.
String	getText()	The text value.
URI	getType()	The type of the field value.
int	hashCode()
FieldValue	id(String id)	Build up this object with an id.
FieldValue	labelId(String labelId)	Build out this field value with a label id.
FieldValue	lang(String lang)	Build up this conclusion with a lang.
FieldValue	link(String rel, URI href)	Build up this data with a link.
FieldValue	link(Link link)	Build up this data with a link.
FieldValue	note(Note note)	Build up this conclusion with a note.
FieldValue	resource(URI resource)	Build out this field value with a resource.
void	setDatatype(URI datatype)	The datatype of the text value of the field.
void	setKnownStatus(FieldValueStatusType status)	The type of the field.
void	setKnownType(FieldValueType type)	The type of the field value.
void	setLabelId(String labelId)	The id of the label applicable to this field value.
void	setResource(URI resource)	URI that resolves to the value of the field.
void	setStatus(URI status)	The status of this FieldValue.
void	setText(String text)	The text value.
void	setType(URI type)	The type of the field value.
FieldValue	sortKey(String sortKey)	Build up this fact with a sort key.
FieldValue	source(SourceDescription source)	Build up this conclusion with a source reference.
FieldValue	source(SourceReference sourceReference)	Build up this conclusion with a source reference.
FieldValue	text(String text)	Build out this field value with text.
String	toString()	Provide a simple toString() method.
FieldValue	type(URI type)	Build out this field value with a type.
FieldValue	type(FieldValueType type)	Build out this field value with a type.

Methods inherited from class org.gedcomx.conclusion.Conclusion

addNote, addSource, embed, getAnalysis, getAttribution, getConfidence, getKnownConfidenceLevel, getLang, getNotes, getSortKey, getSources, notes, setAnalysis, setAttribution, setConfidence, setKnownConfidenceLevel, setLang, setNotes, setSortKey, setSources, sources

Methods inherited from class org.gedcomx.links.HypermediaEnabledData

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

Methods inherited from class org.gedcomx.common.ExtensibleData

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

Methods inherited from class java.lang.Object

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

Constructor Details

FieldValue

public FieldValue()

FieldValue

public FieldValue(String text)

FieldValue

public FieldValue(FieldValue copy)

Method Details

id

public FieldValue id(String id)

Description copied from class: ExtensibleData

Build up this object with an id.

Overrides:

id in class Conclusion

Parameters:

id - The id.

Returns:

this.

extensionElement

public FieldValue extensionElement(Object element)

Overrides:

extensionElement in class Conclusion

link

public FieldValue link(String rel,
 URI href)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class Conclusion

Parameters:

rel - The rel.

href - The href.

Returns:

this.

link

public FieldValue link(Link link)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class Conclusion

Parameters:

link - The link.

Returns:

this.

lang

public FieldValue lang(String lang)

Description copied from class: Conclusion

Build up this conclusion with a lang.

Overrides:

lang in class Conclusion

Parameters:

lang - The lang.

Returns:

this.

confidence

public FieldValue confidence(URI confidence)

Description copied from class: Conclusion

Build up this conclusion with a confidence level.

Overrides:

confidence in class Conclusion

Parameters:

confidence - The confidence level.

Returns:

this.

confidence

public FieldValue confidence(ConfidenceLevel confidence)

Description copied from class: Conclusion

Build up this conclusion with a confidence level.

Overrides:

confidence in class Conclusion

Parameters:

confidence - The confidence level.

Returns:

this.

source

public FieldValue source(SourceReference sourceReference)

Description copied from class: Conclusion

Build up this conclusion with a source reference.

Overrides:

source in class Conclusion

Parameters:

sourceReference - The source reference.

Returns:

this.

source

public FieldValue source(SourceDescription source)

Description copied from class: Conclusion

Build up this conclusion with a source reference.

Overrides:

source in class Conclusion

Parameters:

source - The source description being referenced.

Returns:

this.

note

public FieldValue note(Note note)

Description copied from class: Conclusion

Build up this conclusion with a note.

Overrides:

note in class Conclusion

Parameters:

note - The note.

Returns:

this.

attribution

public FieldValue attribution(Attribution attribution)

Description copied from class: Conclusion

Build up this conclusion with attribution.

Overrides:

attribution in class Conclusion

Parameters:

attribution - The attribution.

Returns:

this.

analysis

public FieldValue analysis(ResourceReference analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Conclusion

Parameters:

analysis - The analysis.

Returns:

this.

analysis

public FieldValue analysis(Document analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Conclusion

Parameters:

analysis - The analysis.

Returns:

this.

analysis

public FieldValue analysis(URI analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Conclusion

Parameters:

analysis - The analysis.

Returns:

this.

sortKey

public FieldValue sortKey(String sortKey)

Description copied from class: Conclusion

Build up this fact with a sort key.

Overrides:

sortKey in class Conclusion

Parameters:

sortKey - The sort key.

Returns:

this.

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.

type

public FieldValue type(URI type)

Build out this field value with a type.

Parameters:

type - The type.

Returns:

this.

type

public FieldValue type(FieldValueType type)

Build out this field value with a type.

Parameters:

type - The type.

Returns:

this.

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.

getLabelId

public String getLabelId()

The id of the label applicable to this field value.

Returns:

The id of the label applicable to this field value.

setLabelId

public void setLabelId(String labelId)

The id of the label applicable to this field value.

Parameters:

labelId - The id of the label applicable to this field value.

labelId

public FieldValue labelId(String labelId)

Build out this field value with a label id.

Parameters:

labelId - The label id.

Returns:

this.

getText

public String getText()

The text value.

Returns:

The text value.

setText

public void setText(String text)

The text value.

Parameters:

text - The text value.

text

public FieldValue text(String text)

Build out this field value with text.

Parameters:

text - the text.

Returns:

this.

getDatatype

public URI getDatatype()

The datatype of the text value of the field.

Returns:

The datatype of the text value of the field.

setDatatype

public void setDatatype(URI datatype)

The datatype of the text value of the field.

Parameters:

datatype - The datatype of the text value of the field.

datatype

public FieldValue datatype(URI datatype)

Build out this field value with a data type.

Parameters:

datatype - The data type.

Returns:

this

getResource

public URI getResource()

URI that resolves to the value of the field.

Returns:

URI that resolves to the value of the field.

setResource

public void setResource(URI resource)

URI that resolves to the value of the field.

Parameters:

resource - URI that resolves to the value of the field.

resource

public FieldValue resource(URI resource)

Build out this field value with a resource.

Parameters:

resource - The resource.

Returns:

this.

getStatus

public URI getStatus()

The status of this FieldValue.

Returns:

URI of the field value status type of this field value.

See Also:

• FieldValueStatusType

setStatus

public void setStatus(URI status)

The status of this FieldValue.

Parameters:

status - The status.

See Also:

• FieldValueStatusType

getKnownStatus

public FieldValueStatusType getKnownStatus()

The known type of the field.

Returns:

The type of the field.

setKnownStatus

public void setKnownStatus(FieldValueStatusType status)

The type of the field.

Parameters:

status - The field value status type of the field.

accept

public void accept(GedcomxModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor to accept.

toString

public String toString()

Provide a simple toString() method.

Overrides:

toString in class Conclusion

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object