org.gedcomx.conclusion

Class Conclusion

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.links.HypermediaEnabledData

org.gedcomx.conclusion.Conclusion

All Implemented Interfaces:

Attributable, HasNotes, HasTransientProperties, SupportsLinks, SupportsExtensionElements, ReferencesSources

Direct Known Subclasses:

Document, EventRole, Fact, Field, FieldValue, Gender, Name, Subject

public abstract class Conclusion
extends HypermediaEnabledData
implements Attributable, ReferencesSources, HasNotes

A genealogical conclusion.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor and Description
Conclusion()

Method Summary

Modifier and Type	Method and Description
void	addNote(Note note) Add a note.
void	addSource(SourceReference source) Add a source reference.
Conclusion	analysis(Document analysis) Add a reference to the analysis for this conclusion.
Conclusion	analysis(ResourceReference analysis) Add a reference to the analysis for this conclusion.
Conclusion	analysis(URI analysis) Add a reference to the analysis for this conclusion.
Conclusion	attribution(Attribution attribution) Build up this conclusion with attribution.
Conclusion	confidence(ConfidenceLevel confidence) Build up this conclusion with a confidence level.
Conclusion	confidence(URI confidence) Build up this conclusion with a confidence level.
void	embed(Conclusion conclusion)
Conclusion	extensionElement(Object element)
ResourceReference	getAnalysis() A reference to the analysis document explaining the analysis that went into this conclusion.
Attribution	getAttribution() Attribution metadata for a conclusion.
URI	getConfidence() The level of confidence the contributor has about the data.
ConfidenceLevel	getKnownConfidenceLevel() The value of a the known confidence level, or ConfidenceLevel.OTHER if not known.
String	getLang() The language of the conclusion.
List<Note>	getNotes() Notes about a person.
String	getSortKey() A sort key in relation to other facts for display purposes.
List<SourceReference>	getSources() The source references for a conclusion.
Conclusion	id(String id) Build up this object with an id.
Conclusion	lang(String lang) Build up this conclusion with a lang.
Conclusion	link(Link link) Build up this data with a link.
Conclusion	link(String rel, URI href) Build up this data with a link.
Conclusion	note(Note note) Build up this conclusion with a note.
void	setAnalysis(ResourceReference analysis) A reference to the analysis document explaining the analysis that went into this conclusion.
void	setAttribution(Attribution attribution) Attribution metadata for a conclusion.
void	setConfidence(URI confidence) The level of confidence the contributor has about the data.
void	setKnownConfidenceLevel(ConfidenceLevel level) Set the confidence level from a known enumeration of confidence levels.
void	setLang(String lang) The language of the conclusion.
void	setNotes(List<Note> notes) Notes about a person.
void	setSortKey(String sortKey) A sort key in relation to other facts for display purposes.
void	setSources(List<SourceReference> sourceReferences) The source references for a conclusion.
Conclusion	sortKey(String sortKey) Build up this fact with a sort key.
Conclusion	source(SourceDescription source) Build up this conclusion with a source reference.
Conclusion	source(SourceReference sourceReference) Build up this conclusion with a source reference.
String	toString() Provide a simple toString() method.

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

Constructor Detail

Conclusion

public Conclusion()

Method Detail

id

public Conclusion id(String id)

Description copied from class: ExtensibleData

Build up this object with an id.

Overrides:

id in class ExtensibleData

Parameters:

id - The id.

Returns:

this.

extensionElement

public Conclusion extensionElement(Object element)

Overrides:

extensionElement in class ExtensibleData

link

public Conclusion link(String rel,
                       URI href)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class HypermediaEnabledData

Parameters:

rel - The rel.

href - The href.

Returns:

this.

link

public Conclusion link(Link link)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class HypermediaEnabledData

Parameters:

link - The link.

Returns:

this.

getLang

public String getLang()

The language of the conclusion. See http://www.w3.org/International/articles/language-tags/

Returns:

The language of the conclusion.

setLang

public void setLang(String lang)

The language of the conclusion. See http://www.w3.org/International/articles/language-tags/

Parameters:

lang - The language of the conclusion.

lang

public Conclusion lang(String lang)

Build up this conclusion with a lang.

Parameters:

lang - The lang.

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 Conclusion confidence(URI confidence)

Build up this conclusion with a confidence level.

Parameters:

confidence - The confidence level.

Returns:

this.

confidence

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

getSources

public List<SourceReference> getSources()

The source references for a conclusion.

Specified by:

getSources in interface ReferencesSources

Returns:

The source references for a conclusion.

setSources

public void setSources(List<SourceReference> sourceReferences)

The source references for a conclusion.

Specified by:

setSources in interface ReferencesSources

Parameters:

sourceReferences - The source references for a conclusion.

source

public Conclusion source(SourceReference sourceReference)

Build up this conclusion with a source reference.

Parameters:

sourceReference - The source reference.

Returns:

this.

source

public Conclusion source(SourceDescription source)

Build up this conclusion with a source reference.

Parameters:

source - The source description being referenced.

Returns:

this.

addSource

public void addSource(SourceReference source)

Add a source reference.

Parameters:

source - The source reference to be added.

getNotes

public List<Note> getNotes()

Notes about a person.

Specified by:

getNotes in interface HasNotes

Returns:

Notes about a person.

setNotes

public void setNotes(List<Note> notes)

Notes about a person.

Specified by:

setNotes in interface HasNotes

Parameters:

notes - Notes about a person.

note

public Conclusion note(Note note)

Build up this conclusion with a note.

Parameters:

note - The note.

Returns:

this.

addNote

public void addNote(Note note)

Add a note.

Parameters:

note - The note to be added.

getAttribution

public Attribution getAttribution()

Attribution metadata for a conclusion.

Specified by:

getAttribution in interface Attributable

Returns:

Attribution metadata for a conclusion.

setAttribution

public void setAttribution(Attribution attribution)

Attribution metadata for a conclusion.

Specified by:

setAttribution in interface Attributable

Parameters:

attribution - Attribution metadata for a conclusion.

attribution

public Conclusion attribution(Attribution attribution)

Build up this conclusion with attribution.

Parameters:

attribution - The attribution.

Returns:

this.

getAnalysis

public ResourceReference getAnalysis()

A reference to the analysis document explaining the analysis that went into this conclusion.

Returns:

A reference to the analysis document explaining the analysis that went into this conclusion.

setAnalysis

public void setAnalysis(ResourceReference analysis)

A reference to the analysis document explaining the analysis that went into this conclusion.

Parameters:

analysis - A reference to the analysis document explaining the analysis that went into this conclusion.

analysis

public Conclusion analysis(ResourceReference analysis)

Add a reference to the analysis for this conclusion.

Parameters:

analysis - The analysis.

Returns:

this.

analysis

public Conclusion analysis(URI analysis)

Add a reference to the analysis for this conclusion.

Parameters:

analysis - The analysis.

Returns:

this.

analysis

public Conclusion analysis(Document analysis)

Add a reference to the analysis for this conclusion.

Parameters:

analysis - The analysis.

Returns:

this.

getSortKey

public String getSortKey()

A sort key in relation to other facts for display purposes.

Returns:

A sort key in relation to other facts for display purposes.

setSortKey

public void setSortKey(String sortKey)

A sort key in relation to other facts for display purposes.

Parameters:

sortKey - A sort key in relation to other facts for display purposes.

sortKey

public Conclusion sortKey(String sortKey)

Build up this fact with a sort key.

Parameters:

sortKey - The sort key.

Returns:

this.

toString

public String toString()

Provide a simple toString() method.

Overrides:

toString in class ExtensibleData

embed

public void embed(Conclusion conclusion)