org.gedcomx.conclusion

Class PlaceReference

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.conclusion.PlaceReference

All Implemented Interfaces:

HasTransientProperties, HasFields, SupportsExtensionElements

public class PlaceReference
extends ExtensibleData
implements HasFields

A reference to genealogical place.

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor and Description
PlaceReference()

Method Summary

Modifier and Type	Method and Description
void	accept(GedcomxModelVisitor visitor) Accept a visitor.
void	addField(Field field) Add a reference to the record field values being used as evidence.
void	addNormalizedExtension(TextValue normalized) Add a normalized value.
PlaceReference	confidence(ConfidenceLevel confidence) Build up this conclusion with a confidence level.
PlaceReference	confidence(URI confidence) Build up this conclusion with a confidence level.
PlaceReference	description(PlaceDescription description) Build out this place reference with a reference to a place description.
PlaceReference	description(URI ref) Build out this place reference with a reference to a place description.
PlaceReference	field(Field field) Build out this place reference with a field.
URI	getConfidence() The level of confidence the contributor has about the data.
URI	getDescriptionRef() A reference to a description of the place being referenced.
List<Field>	getFields() Get the fields being used as evidence.
ConfidenceLevel	getKnownConfidenceLevel() The value of a the known confidence level, or ConfidenceLevel.OTHER if not known.
List<TextValue>	getNormalizedExtensions() The list of normalized values for the place, provided for display purposes by the application.
String	getOriginal() The original value as supplied by the user.
PlaceReference	normalized(String normalized) Build out this place reference with an normalized string.
Stream<TextValue>	normalizedExtensions() Create a stream for the normalized value extensions.
PlaceReference	original(String original) Build out this place reference with an original string.
void	setConfidence(URI confidence) The level of confidence the contributor has about the data.
void	setDescriptionRef(URI descriptionRef) A reference to a description of the place being referenced.
void	setFields(List<Field> fields) Set the list of fields being used as evidence.
void	setKnownConfidenceLevel(ConfidenceLevel level) Set the confidence level from a known enumeration of confidence levels.
void	setNormalizedExtensions(List<TextValue> normalized) The list of normalized values for the place, provided for display purposes by the application.
void	setOriginal(String original) The original value as supplied by the user.
String	toString() Provide a simple toString() method.

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gedcomx.records.HasFields

fields

Constructor Detail

PlaceReference

public PlaceReference()

Method Detail

getOriginal

public String getOriginal()

The original value as supplied by the user.

Returns:

The original value as supplied by the user.

setOriginal

public void setOriginal(String original)

The original value as supplied by the user.

Parameters:

original - The original value as supplied by the user.

original

public PlaceReference original(String original)

Build out this place reference with an original string.

Parameters:

original - The original string.

Returns:

this.

getDescriptionRef

public URI getDescriptionRef()

A reference to a description of the place being referenced.

Returns:

A reference to a description of the place being referenced.

setDescriptionRef

public void setDescriptionRef(URI descriptionRef)

A reference to a description of the place being referenced.

Parameters:

descriptionRef - A reference to a description of the place being referenced.

description

public PlaceReference description(PlaceDescription description)

Build out this place reference with a reference to a place description.

Parameters:

description - The reference to the place description.

Returns:

this.

description

public PlaceReference description(URI ref)

Build out this place reference with a reference to a place description.

Parameters:

ref - The reference to the place description.

Returns:

this.

getConfidence

public URI getConfidence()

The level of confidence the contributor has about the data.

Returns:

The level of confidence the contributor has about the data.

setConfidence

public void setConfidence(URI confidence)

The level of confidence the contributor has about the data.

Parameters:

confidence - The level of confidence the contributor has about the data.

confidence

public PlaceReference confidence(URI confidence)

Build up this conclusion with a confidence level.

Parameters:

confidence - The confidence level.

Returns:

this.

confidence

public PlaceReference confidence(ConfidenceLevel confidence)

Build up this conclusion with a confidence level.

Parameters:

confidence - The confidence level.

Returns:

this.

getKnownConfidenceLevel

public ConfidenceLevel getKnownConfidenceLevel()

The value of a the known confidence level, or ConfidenceLevel.OTHER if not known.

Returns:

The value of a the known confidence level, or ConfidenceLevel.OTHER if not known.

setKnownConfidenceLevel

public void setKnownConfidenceLevel(ConfidenceLevel level)

Set the confidence level from a known enumeration of confidence levels.

Parameters:

level - The known level.

normalizedExtensions

public Stream<TextValue> normalizedExtensions()

Create a stream for the normalized value extensions.

Returns:

a stream for the normalized value extensions.

getNormalizedExtensions

public List<TextValue> getNormalizedExtensions()

The list of normalized values for the place, provided for display purposes by the application. Normalized values are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Returns:

The list of normalized values for the place, provided for display purposes by the application. Normalized values are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

setNormalizedExtensions

public void setNormalizedExtensions(List<TextValue> normalized)

The list of normalized values for the place, provided for display purposes by the application. Normalized values are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Parameters:

normalized - The list of normalized values for the place, provided for display purposes by the application. Normalized values are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

addNormalizedExtension

public void addNormalizedExtension(TextValue normalized)

Add a normalized value.

Parameters:

normalized - The normalized value.

normalized

public PlaceReference normalized(String normalized)

Build out this place reference with an normalized string.

Parameters:

normalized - The normalized string.

Returns:

this.

getFields

public List<Field> getFields()

Get the fields being used as evidence.

Specified by:

getFields in interface HasFields

Returns:

The references to the record fields being used as evidence.

setFields

public void setFields(List<Field> fields)

Set the list of fields being used as evidence.

Specified by:

setFields in interface HasFields

Parameters:

fields - - List of fields

addField

public void addField(Field field)

Add a reference to the record field values being used as evidence.

Parameters:

field - The field to be added.

field

public PlaceReference field(Field field)

Build out this place reference with a field.

Parameters:

field - The field.

Returns:

this.

toString

public String toString()

Description copied from class: ExtensibleData

Provide a simple toString() method.

Overrides:

toString in class ExtensibleData

accept

public void accept(GedcomxModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor.