org.gedcomx.conclusion
Class PlaceDescription

java.lang.Object
  org.gedcomx.common.ExtensibleData
      org.gedcomx.links.HypermediaEnabledData
          org.gedcomx.conclusion.Conclusion
              org.gedcomx.conclusion.Subject
                  org.gedcomx.conclusion.PlaceDescription

All Implemented Interfaces:

Attributable, HasNotes, HasTransientProperties, SupportsLinks, SupportsExtensionElements, ReferencesSources

public class PlaceDescription
extends Subject

A PlaceDescription is used to describe the details of a place in terms of its name and possibly its type, time period, and/or a geospatial description -- a description of a place as a snapshot in time.

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

PlaceDescription()

Method Summary

void	accept(GedcomxModelVisitor visitor) Accept a visitor.
void	addName(TextValue name) Add a name to the list of standardized names.
PlaceDescription	analysis(Document analysis) Add a reference to the analysis for this conclusion.
PlaceDescription	analysis(ResourceReference analysis) Add a reference to the analysis for this conclusion.
PlaceDescription	analysis(URI analysis) Add a reference to the analysis for this conclusion.
PlaceDescription	attribution(Attribution attribution) Build up this conclusion with attribution.
PlaceDescription	confidence(ConfidenceLevel confidence) Build up this conclusion with a confidence level.
PlaceDescription	confidence(URI confidence) Build up this conclusion with a confidence level.
PlaceDescription	displayExtension(PlaceDisplayProperties display) Build out this place with a display exension.
void	embed(PlaceDescription place) Embed another place.
PlaceDescription	evidence(EvidenceReference evidence) Build up this subject with an evidence reference.
PlaceDescription	evidence(PlaceDescription evidence)
PlaceDescription	extracted(Boolean extracted) Build up this subject with an extracted flag.
PlaceDisplayProperties	getDisplayExtension() Display properties for the place.
ResourceReference	getJurisdiction() A reference to a description of the jurisdiction this place.
Double	getLatitude() Degrees north or south of the Equator (0.0 degrees).
Double	getLongitude() Angular distance in degrees, relative to the Prime Meridian.
List<TextValue>	getNames() An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place.
ResourceReference	getPlace() A reference to the place being described.
ResourceReference	getSpatialDescription() A reference to a geospatial description of this place.
Date	getTemporalDescription() A description of the time period to which this place description is relevant.
URI	getType() An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).
PlaceDescription	id(String id) Build up this object with an id.
PlaceDescription	identifier(Identifier identifier) Build up this subject with an identifier.
PlaceDescription	jurisdiction(ResourceReference jurisdiction) Build out this place description with a jurisdiction.
PlaceDescription	lang(String lang) Build up this conclusion with a lang.
PlaceDescription	latitude(Double latitude) Build out this place description with a latitude.
PlaceDescription	link(Link link) Build up this data with a link.
PlaceDescription	link(String rel, URI href) Build up this data with a link.
PlaceDescription	longitude(Double longitude) Build out this place description with a longitude.
PlaceDescription	media(SourceDescription media) Build up this subject with a media reference.
PlaceDescription	media(SourceReference media) Build up this subject with a media reference.
PlaceDescription	name(String name) Build out this description with a name.
PlaceDescription	name(TextValue name) Build out this description with a name.
PlaceDescription	note(Note note) Build up this conclusion with a note.
PlaceDescription	place(ResourceReference place) Build out this place description with a place.
void	setDisplayExtension(PlaceDisplayProperties display) Display properties for the place.
void	setJurisdiction(ResourceReference jurisdiction) A reference to a description of the jurisdiction this place.
void	setLatitude(Double latitude) Degrees north or south of the Equator (0.0 degrees).
void	setLongitude(Double longitude) Angular distance in degrees, relative to the Prime Meridian.
void	setNames(List<TextValue> names) An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place.
void	setPlace(ResourceReference place) A reference to the place being described.
void	setSpatialDescription(ResourceReference spatialDescription) A reference to a geospatial description of this place.
void	setTemporalDescription(Date temporalDescription) A description of the time period to which this place description is relevant.
void	setType(URI type) An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).
PlaceDescription	sortKey(String sortKey) Build up this fact with a sort key.
PlaceDescription	source(SourceDescription source) Build up this conclusion with a source reference.
PlaceDescription	source(SourceReference sourceReference) Build up this conclusion with a source reference.
PlaceDescription	spatialDescription(ResourceReference spatialDescription) Build out this place description with a spacial description.
PlaceDescription	temporalDescription(Date temporalDescription) Build out this place description with a temporal description.
PlaceDescription	type(URI type) Build out this place description with a type.

Methods inherited from class org.gedcomx.conclusion.Subject

addEvidence, addIdentifier, addMedia, embed, getEvidence, getExtracted, getIdentifiers, getMedia, getPersistentId, setEvidence, setExtracted, setIdentifiers, setMedia, setPersistentId

Methods inherited from class org.gedcomx.conclusion.Conclusion

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

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gedcomx.common.Attributable

getAttribution, setAttribution

Constructor Detail

PlaceDescription

public PlaceDescription()

Method Detail

id

public PlaceDescription id(String id)

Description copied from class: ExtensibleData

Build up this object with an id.

Overrides:

id in class Subject

Parameters:

id - The id.

link

public PlaceDescription link(String rel,
                             URI href)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class Subject

Parameters:

rel - The rel.

href - The href.

Returns:

this.

link

public PlaceDescription link(Link link)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class Subject

Parameters:

link - The link.

Returns:

this.

lang

public PlaceDescription lang(String lang)

Description copied from class: Conclusion

Build up this conclusion with a lang.

Overrides:

lang in class Subject

Parameters:

lang - The lang.

Returns:

this.

confidence

public PlaceDescription confidence(URI confidence)

Description copied from class: Conclusion

Build up this conclusion with a confidence level.

Overrides:

confidence in class Subject

Parameters:

confidence - The confidence level.

Returns:

this.

confidence

public PlaceDescription confidence(ConfidenceLevel confidence)

Description copied from class: Conclusion

Build up this conclusion with a confidence level.

Overrides:

confidence in class Subject

Parameters:

confidence - The confidence level.

Returns:

this.

source

public PlaceDescription source(SourceReference sourceReference)

Description copied from class: Conclusion

Build up this conclusion with a source reference.

Overrides:

source in class Subject

Parameters:

sourceReference - The source reference.

Returns:

this.

source

public PlaceDescription source(SourceDescription source)

Description copied from class: Conclusion

Build up this conclusion with a source reference.

Overrides:

source in class Subject

Parameters:

source - The source description being referenced.

Returns:

this.

note

public PlaceDescription note(Note note)

Description copied from class: Conclusion

Build up this conclusion with a note.

Overrides:

note in class Subject

Parameters:

note - The note.

Returns:

this.

analysis

public PlaceDescription analysis(ResourceReference analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Subject

Parameters:

analysis - The analysis.

Returns:

this.

attribution

public PlaceDescription attribution(Attribution attribution)

Description copied from class: Conclusion

Build up this conclusion with attribution.

Overrides:

attribution in class Subject

Parameters:

attribution - The attribution.

Returns:

this.

analysis

public PlaceDescription analysis(Document analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Subject

Parameters:

analysis - The analysis.

Returns:

this.

analysis

public PlaceDescription analysis(URI analysis)

Description copied from class: Conclusion

Add a reference to the analysis for this conclusion.

Overrides:

analysis in class Subject

Parameters:

analysis - The analysis.

Returns:

this.

extracted

public PlaceDescription extracted(Boolean extracted)

Description copied from class: Subject

Build up this subject with an extracted flag.

Overrides:

extracted in class Subject

Parameters:

extracted - The extracted flag.

Returns:

this.

identifier

public PlaceDescription identifier(Identifier identifier)

Description copied from class: Subject

Build up this subject with an identifier.

Overrides:

identifier in class Subject

Parameters:

identifier - The identifier.

Returns:

this.

evidence

public PlaceDescription evidence(EvidenceReference evidence)

Description copied from class: Subject

Build up this subject with an evidence reference.

Overrides:

evidence in class Subject

Parameters:

evidence - The evidence reference.

Returns:

this.

evidence

public PlaceDescription evidence(PlaceDescription evidence)

media

public PlaceDescription media(SourceReference media)

Description copied from class: Subject

Build up this subject with a media reference.

Overrides:

media in class Subject

Parameters:

media - The media reference.

Returns:

this.

media

public PlaceDescription media(SourceDescription media)

Description copied from class: Subject

Build up this subject with a media reference.

Overrides:

media in class Subject

Parameters:

media - The media reference.

Returns:

this.

sortKey

public PlaceDescription sortKey(String sortKey)

Description copied from class: Conclusion

Build up this fact with a sort key.

Overrides:

sortKey in class Subject

Parameters:

sortKey - The sort key.

Returns:

this.

getNames

public List<TextValue> getNames()

An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place. The list MUST include at least one value. It is RECOMMENDED that instances include a single name and any equivalents from other cultural contexts; name variants should more typically be described in separate PlaceDescription instances. The list is assumed to be given in order of preference, with the most preferred value in the first position in the list.

Returns:

An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place.

setNames

public void setNames(List<TextValue> names)

An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place. The list MUST include at least one value. It is RECOMMENDED that instances include a single name and any equivalents from other cultural contexts; name variants should more typically be described in separate PlaceDescription instances. The list is assumed to be given in order of preference, with the most preferred value in the first position in the list.

Parameters:

names - An ordered list of standardized (or normalized), fully-qualified (in terms of what is known of the applicable jurisdictional hierarchy) names for this place that are applicable to this description of this place.

name

public PlaceDescription name(TextValue name)

Build out this description with a name.

Parameters:

name - The name.

Returns:

this.

name

public PlaceDescription name(String name)

Build out this description with a name.

Parameters:

name - The name.

Returns:

this.

addName

public void addName(TextValue name)

Add a name to the list of standardized names.

Parameters:

name - The name to be added.

getType

public URI getType()

An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).

Returns:

An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).

setType

public void setType(URI type)

An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).

Parameters:

type - An implementation-specific uniform resource identifier (URI) used to identify the type of a place (e.g., address, city, county, province, state, country, etc.).

type

public PlaceDescription type(URI type)

Build out this place description with a type.

Parameters:

type - The type.

Returns:

this.

getTemporalDescription

public Date getTemporalDescription()

A description of the time period to which this place description is relevant.

Returns:

A description of the time period to which this place description is relevant.

setTemporalDescription

public void setTemporalDescription(Date temporalDescription)

A description of the time period to which this place description is relevant.

Parameters:

temporalDescription - A description of the time period to which this place description is relevant.

temporalDescription

public PlaceDescription temporalDescription(Date temporalDescription)

Build out this place description with a temporal description.

Parameters:

temporalDescription - the temporal description.

Returns:

this.

getLatitude

public Double getLatitude()

Degrees north or south of the Equator (0.0 degrees). Values range from −90.0 degrees (south) to 90.0 degrees (north).

Returns:

Degrees north or south of the Equator.

setLatitude

public void setLatitude(Double latitude)

Degrees north or south of the Equator (0.0 degrees). Values range from −90.0 degrees (south) to 90.0 degrees (north).

Parameters:

latitude - Degrees north or south of the Equator.

latitude

public PlaceDescription latitude(Double latitude)

Build out this place description with a latitude.

Parameters:

latitude - The latitude.

Returns:

this.

getLongitude

public Double getLongitude()

Angular distance in degrees, relative to the Prime Meridian. Values range from −180.0 degrees (west of the Meridian) to 180.0 degrees (east of the Meridian).

Returns:

Angular distance in degrees, relative to the Prime Meridian.

setLongitude

public void setLongitude(Double longitude)

Angular distance in degrees, relative to the Prime Meridian. Values range from −180.0 degrees (west of the Meridian) to 180.0 degrees (east of the Meridian).

Parameters:

longitude - Angular distance in degrees, relative to the Prime Meridian.

longitude

public PlaceDescription longitude(Double longitude)

Build out this place description with a longitude.

Parameters:

longitude - The longitude.

Returns:

this.

getSpatialDescription

public ResourceReference getSpatialDescription()

A reference to a geospatial description of this place. It is RECOMMENDED that this description resolve to a KML document.

Returns:

A reference to a geospatial description of this place.

setSpatialDescription

public void setSpatialDescription(ResourceReference spatialDescription)

A reference to a geospatial description of this place. It is RECOMMENDED that this description resolve to a KML document.

Parameters:

spatialDescription - A reference to a geospatial description of this place.

spatialDescription

public PlaceDescription spatialDescription(ResourceReference spatialDescription)

Build out this place description with a spacial description.

Parameters:

spatialDescription - The spatial description.

Returns:

this

getJurisdiction

public ResourceReference getJurisdiction()

A reference to a description of the jurisdiction this place.

Returns:

A reference to a description of the jurisdiction this place.

setJurisdiction

public void setJurisdiction(ResourceReference jurisdiction)

A reference to a description of the jurisdiction this place.

Parameters:

jurisdiction - A reference to a description of the jurisdiction this place.

jurisdiction

public PlaceDescription jurisdiction(ResourceReference jurisdiction)

Build out this place description with a jurisdiction.

Parameters:

jurisdiction - The reference to the jurisdiction.

Returns:

this

getPlace

public ResourceReference getPlace()

A reference to the place being described.

Returns:

A reference to the place being described.

setPlace

public void setPlace(ResourceReference place)

A reference to the place being described.

Parameters:

place - A reference to the place being described.

place

public PlaceDescription place(ResourceReference place)

Build out this place description with a place.

Parameters:

place - The reference to the place.

Returns:

this

getDisplayExtension

public PlaceDisplayProperties getDisplayExtension()

Display properties for the place. Display properties are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Returns:

Display properties for the place. Display properties are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

setDisplayExtension

public void setDisplayExtension(PlaceDisplayProperties display)

Display properties for the place. Display properties are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Parameters:

display - Display properties for the place. Display properties are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

displayExtension

public PlaceDescription displayExtension(PlaceDisplayProperties display)

Build out this place with a display exension.

Parameters:

display - the display.

Returns:

this

accept

public void accept(GedcomxModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor.

embed

public void embed(PlaceDescription place)

Embed another place.

Parameters:

place - The place to embed.