Package 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

  • Constructor Details

    • Conclusion

      protected Conclusion()

    • Conclusion

      protected Conclusion(Conclusion copy)

  • Method Details

    • 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.

    • sources

      public Stream<SourceReference> sources()
      Create a stream for the sources of this conclusion.
      Returns:
      a stream for the sources of this conclusion.

    • 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.

    • notes

      public Stream<Note> notes()
      Create a stream for the notes of this conclusion.
      Returns:
      a stream for the notes of this conclusion.

    • 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)