org.gedcomx.conclusion
Class Person

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

All Implemented Interfaces:

Attributable, HasNotes, HasTransientProperties, HasFacts, SupportsLinks, HasFields, SupportsExtensionElements, ReferencesSources

public class Person
extends Subject
implements HasFacts, HasFields

A person.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Person()

Method Summary

void	accept(GedcomxModelVisitor visitor) Accept a visitor.
void	addFact(Fact fact) Add a fact conclusion to the person.
void	addField(Field field) Add a reference to the record field values being used as evidence.
void	addName(Name name) Add a name conclusion to the person.
void	addPersona(EvidenceReference personaRef) Add an persona reference for this subject.
Person	analysis(Document analysis) Add a reference to the analysis for this conclusion.
Person	analysis(ResourceReference analysis) Add a reference to the analysis for this conclusion.
Person	analysis(URI analysis) Add a reference to the analysis for this conclusion.
Person	attribution(Attribution attribution) Build up this conclusion with attribution.
Person	confidence(ConfidenceLevel confidence) Build up this conclusion with a confidence level.
Person	confidence(URI confidence) Build up this conclusion with a confidence level.
Person	displayExtension(DisplayProperties display) Build out this person with a display exension.
void	embed(Person person) Embed the specified person into this one.
Person	evidence(EvidenceReference evidence) Build up this subject with an evidence reference.
Person	evidence(Person evidence)
Person	extracted(Boolean extracted) Build up this subject with an extracted flag.
Person	fact(Fact fact) Build out this person with a fact.
Person	field(Field field) Build out this person with a field.
Person	gender(Gender gender) Build out this person with a gender.
Person	gender(GenderType gender) Build out this person with a gender.
DisplayProperties	getDisplayExtension() Display properties for the person.
List<Fact>	getFacts() The fact conclusions for the person.
List<Fact>	getFacts(FactType factType) Helper method for obtaining specific fact conclusions.
List<Field>	getFields() Get the fields being used as evidence.
Fact	getFirstFactOfType(FactType type) Get the first fact of the specified type.
Name	getFirstNameOfType(NameType type) Get the first name of the specified type.
Gender	getGender() The gender conclusion for the person.
Boolean	getLiving() Living status of the person as treated by the system.
Name	getName() Get the first name of this person.
List<Name>	getNames() The name conclusions for the person.
List<EvidenceReference>	getPersonaReferences() References to the persona being referenced for this subject.
Boolean	getPrincipal() Indicator of whether this person is the "principal" person extracted from the record.
Boolean	getPrivate() Whether this person has been designated for limited distribution or display.
Person	id(String id) Build up this object with an id.
Person	identifier(Identifier identifier) Build up this subject with an identifier.
Person	lang(String lang) Build up this conclusion with a lang.
Person	link(Link link) Build up this data with a link.
Person	link(String rel, URI href) Build up this data with a link.
Person	living(Boolean living) Build out this person with a living flag.
Person	media(SourceDescription media) Build up this subject with a media reference.
Person	media(SourceReference media) Build up this subject with a media reference.
Person	name(Name name) Build out this person with a name.
Person	name(String name) Build out this person with a name.
Person	note(Note note) Build up this conclusion with a note.
Subject	personaReference(EvidenceReference persona) Build up this subject with an persona reference.
Person	principal(Boolean principal) Build out this person with a principal flag.
void	setDisplayExtension(DisplayProperties display) Display properties for the person.
void	setFacts(List<Fact> facts) The fact conclusions for the person.
void	setFields(List<Field> fields) Set the list of fields being used as evidence.
void	setGender(Gender gender) The gender conclusion for the person.
void	setLiving(Boolean living) Living status of the person as treated by the system.
void	setNames(List<Name> names) The name conclusions for the person.
void	setPersonaReferences(List<EvidenceReference> refs) References to the persona being referenced for this subject.
void	setPrincipal(Boolean principal) Indicator of whether this person is the "principal" person extracted from the record.
void	setPrivate(Boolean isPrivate) Whether this person has been designated for limited distribution or display.
Person	sortKey(String sortKey) Build up this fact with a sort key.
Person	source(SourceDescription source) Build up this conclusion with a source reference.
Person	source(SourceReference sourceReference) Build up this conclusion with a source reference.
String	toString() Provide a simple toString() method.

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

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

Person

public Person()

Method Detail

id

public Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person 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 Person evidence(Person evidence)

getPersonaReferences

public List<EvidenceReference> getPersonaReferences()

References to the persona being referenced for this subject.

Returns:

References to the persona being referenced.

setPersonaReferences

public void setPersonaReferences(List<EvidenceReference> refs)

References to the persona being referenced for this subject.

Parameters:

refs - References to the persona being referenced.

personaReference

public Subject personaReference(EvidenceReference persona)

Build up this subject with an persona reference.

Parameters:

persona - The persona reference.

Returns:

this.

addPersona

public void addPersona(EvidenceReference personaRef)

Add an persona reference for this subject.

Parameters:

personaRef - The persona to be added.

media

public Person 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 Person 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 Person 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.

getPrivate

public Boolean getPrivate()

Whether this person has been designated for limited distribution or display.

Returns:

Whether this person has been designated for limited distribution or display.

setPrivate

public void setPrivate(Boolean isPrivate)

Whether this person has been designated for limited distribution or display.

Parameters:

isPrivate - Whether this person has been designated for limited distribution or display.

getLiving

public Boolean getLiving()

Living status of the person as treated by the system. The value of this property is intended to be based on a system-specific calculation and therefore has limited portability. Conclusions about the living status of a person can be modeled with a fact.

Returns:

Living status of the person as treated by the system.

setLiving

public void setLiving(Boolean living)

Living status of the person as treated by the system. The value of this property is intended to be based on a system-specific calculation and therefore has limited portability. Conclusions about the living status of a person can be modeled with a fact.

Parameters:

living - Living status of the person as treated by the system.

living

public Person living(Boolean living)

Build out this person with a living flag.

Parameters:

living - The flag.

Returns:

this.

getPrincipal

public Boolean getPrincipal()

Indicator of whether this person is the "principal" person extracted from the record. Applicable only to extracted persons. The meaning of this flag outside the scope of an extracted person is undefined.

Returns:

Whether this person is the "principal" person extracted from the record.

setPrincipal

public void setPrincipal(Boolean principal)

Indicator of whether this person is the "principal" person extracted from the record. Applicable only to extracted persons. The meaning of this flag outside the scope of an extracted person is undefined.

Parameters:

principal - Whether this person is the "principal" person extracted from the record.

principal

public Person principal(Boolean principal)

Build out this person with a principal flag.

Parameters:

principal - The principal flag.

Returns:

this

getGender

public Gender getGender()

The gender conclusion for the person.

Returns:

The gender conclusion for the person.

setGender

public void setGender(Gender gender)

The gender conclusion for the person.

Parameters:

gender - The gender conclusion for the person.

gender

public Person gender(Gender gender)

Build out this person with a gender.

Parameters:

gender - The gender.

Returns:

this.

gender

public Person gender(GenderType gender)

Build out this person with a gender.

Parameters:

gender - The gender.

Returns:

this.

getNames

public List<Name> getNames()

The name conclusions for the person.

Returns:

The name conclusions for the person.

getName

public Name getName()

Get the first name of this person.

Returns:

The first name of this person.

getFirstNameOfType

public Name getFirstNameOfType(NameType type)

Get the first name of the specified type.

Parameters:

type - The type.

Returns:

the first name in the name list of the specified type, or null if none.

setNames

public void setNames(List<Name> names)

The name conclusions for the person.

Parameters:

names - The name conclusions for the person.

name

public Person name(Name name)

Build out this person with a name.

Parameters:

name - The name.

Returns:

this.

name

public Person name(String name)

Build out this person with a name.

Parameters:

name - The name.

Returns:

this.

addName

public void addName(Name name)

Add a name conclusion to the person.

Parameters:

name - The name conclusion to be added.

getFacts

public List<Fact> getFacts()

The fact conclusions for the person.

Specified by:

getFacts in interface HasFacts

Returns:

The fact conclusions for the person.

getFirstFactOfType

public Fact getFirstFactOfType(FactType type)

Get the first fact of the specified type.

Parameters:

type - The type.

Returns:

the first fact in the fact list of the specified type, or null if none.

getFacts

public List<Fact> getFacts(FactType factType)

Helper method for obtaining specific fact conclusions.

Parameters:

factType - The type of facts to return.

Returns:

The fact conclusions that match the factType. An empty list will be returned if no facts are found.

setFacts

public void setFacts(List<Fact> facts)

The fact conclusions for the person.

Specified by:

setFacts in interface HasFacts

Parameters:

facts - The fact conclusions for the person.

fact

public Person fact(Fact fact)

Build out this person with a fact.

Parameters:

fact - The fact.

Returns:

this.

addFact

public void addFact(Fact fact)

Add a fact conclusion to the person.

Parameters:

fact - The fact conclusion to be added.

getDisplayExtension

public DisplayProperties getDisplayExtension()

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

Returns:

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

setDisplayExtension

public void setDisplayExtension(DisplayProperties display)

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

Parameters:

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

displayExtension

public Person displayExtension(DisplayProperties display)

Build out this person with a display exension.

Parameters:

display - the display.

Returns:

this

accept

public void accept(GedcomxModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor.

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

field

public Person field(Field field)

Build out this person with a field.

Parameters:

field - The field.

Returns:

this.

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.

embed

public void embed(Person person)

Embed the specified person into this one.

Parameters:

person - The person to embed.

toString

public String toString()

Provide a simple toString() method.

Overrides:

toString in class Conclusion