Name (GEDCOM X - Model 2.1.1 API)

java.lang.Object
- org.gedcomx.common.ExtensibleData
- - org.gedcomx.links.HypermediaEnabledData
  - - org.gedcomx.conclusion.Conclusion
    - - org.gedcomx.conclusion.Name

All Implemented Interfaces:

Attributable, HasNotes, HasTransientProperties, SupportsLinks, SupportsExtensionElements, ReferencesSources
```
public class Name
extends Conclusion
```
A name conclusion.

Author:

Ryan Heaton

Field Summary
- Fields inherited from class org.gedcomx.common.ExtensibleData
  extensionElements, transientProperties

Constructor Summary

Constructors
Constructor and Description

Name()

Name(String fullText, NamePart... parts)

Constructors
Constructor and Description
`Name()`
`Name(String fullText, NamePart... parts)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(GedcomxModelVisitor visitor)` Accept a visitor.
`void`	`addNameForm(NameForm nameForm)` Add a name form to the list of name forms.
`Name`	`analysis(Document analysis)` Add a reference to the analysis for this conclusion.
`Name`	`analysis(ResourceReference analysis)` Add a reference to the analysis for this conclusion.
`Name`	`analysis(URI analysis)` Add a reference to the analysis for this conclusion.
`Name`	`attribution(Attribution attribution)` Build up this conclusion with attribution.
`Name`	`confidence(ConfidenceLevel confidence)` Build up this conclusion with a confidence level.
`Name`	`confidence(URI confidence)` Build up this conclusion with a confidence level.
`Name`	`date(Date date)` Build up this name with a date.
`Name`	`extensionElement(Object element)`
`Date`	`getDate()` The date the name was first applied or adopted.
`NameType`	`getKnownType()` The enum referencing the known name type, or `NameType.OTHER` if not known.
`NameForm`	`getNameForm()` The first name form of this name.
`List<NameForm>`	`getNameForms()` Alternate forms of the name, such as the romanized form of a non-latin name.
`String`	`getPart(NamePartType namePartType)` Gets a specific part of the name
`Boolean`	`getPreferred()` Whether the conclusion is preferred above other conclusions of the same type.
`URI`	`getType()` The type of the name.
`Name`	`id(String id)` Build up this object with an id.
`Name`	`lang(String lang)` Build up this conclusion with a lang.
`Name`	`link(Link link)` Build up this data with a link.
`Name`	`link(String rel, URI href)` Build up this data with a link.
`Name`	`nameForm(NameForm nameForm)` Build up this name with a name form.
`Name`	`note(Note note)` Build up this conclusion with a note.
`Name`	`preferred(Boolean preferred)` Build up this name with a preferred flag.
`void`	`setDate(Date date)` The date the name was first applied or adopted.
`void`	`setKnownType(NameType knownType)` Set the name type from an enumeration of known name types.
`void`	`setNameForms(List<NameForm> nameForms)` Alternate forms of the name, such as the romanized form of a non-latin name.
`void`	`setPreferred(Boolean preferred)` Whether the conclusion is preferred above other conclusions of the same type.
`void`	`setType(URI type)` The type of the name.
`Name`	`sortKey(String sortKey)` Build up this fact with a sort key.
`Name`	`source(SourceDescription source)` Build up this conclusion with a source reference.
`Name`	`source(SourceReference sourceReference)` Build up this conclusion with a source reference.
`String`	`toString()` Provide a simple toString() method.
`Name`	`type(NameType type)` Build up this name with a type.
`Name`	`type(URI type)` Build up this name with a type.

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

- Constructor Detail
  - Name
```
public Name()
```
  - Name
```
public Name(String fullText,
            NamePart... parts)
```
- Method Detail
  - id
```
public Name id(String id)
```
    Description copied from class: ExtensibleData
    
    Build up this object with an id.
    
    Overrides:
    
    id in class Conclusion
    
    Parameters:
    
    id - The id.
    
    Returns:
    
    this.
  - extensionElement
```
public Name extensionElement(Object element)
```
    Overrides:
    
    extensionElement in class Conclusion
  - link
```
public Name link(String rel,
                 URI href)
```
    Description copied from class: HypermediaEnabledData
    
    Build up this data with a link.
    
    Overrides:
    
    link in class Conclusion
    
    Parameters:
    
    rel - The rel.
    
    href - The href.
    
    Returns:
    
    this.
  - link
```
public Name link(Link link)
```
    Description copied from class: HypermediaEnabledData
    
    Build up this data with a link.
    
    Overrides:
    
    link in class Conclusion
    
    Parameters:
    
    link - The link.
    
    Returns:
    
    this.
  - lang
```
public Name lang(String lang)
```
    Description copied from class: Conclusion
    
    Build up this conclusion with a lang.
    
    Overrides:
    
    lang in class Conclusion
    
    Parameters:
    
    lang - The lang.
    
    Returns:
    
    this.
  - confidence
```
public Name confidence(URI confidence)
```
    Description copied from class: Conclusion
    
    Build up this conclusion with a confidence level.
    
    Overrides:
    
    confidence in class Conclusion
    
    Parameters:
    
    confidence - The confidence level.
    
    Returns:
    
    this.
  - confidence
```
public Name confidence(ConfidenceLevel confidence)
```
    Description copied from class: Conclusion
    
    Build up this conclusion with a confidence level.
    
    Overrides:
    
    confidence in class Conclusion
    
    Parameters:
    
    confidence - The confidence level.
    
    Returns:
    
    this.
  - source
```
public Name source(SourceReference sourceReference)
```
    Description copied from class: Conclusion
    
    Build up this conclusion with a source reference.
    
    Overrides:
    
    source in class Conclusion
    
    Parameters:
    
    sourceReference - The source reference.
    
    Returns:
    
    this.
  - source
```
public Name source(SourceDescription source)
```
    Description copied from class: Conclusion
    
    Build up this conclusion with a source reference.
    
    Overrides:
    
    source in class Conclusion
    
    Parameters:
    
    source - The source description being referenced.
    
    Returns:
    
    this.
  - note
```
public Name note(Note note)
```
    Description copied from class: Conclusion
    
    Build up this conclusion with a note.
    
    Overrides:
    
    note in class Conclusion
    
    Parameters:
    
    note - The note.
    
    Returns:
    
    this.
  - attribution
```
public Name attribution(Attribution attribution)
```
    Description copied from class: Conclusion
    
    Build up this conclusion with attribution.
    
    Overrides:
    
    attribution in class Conclusion
    
    Parameters:
    
    attribution - The attribution.
    
    Returns:
    
    this.
  - analysis
```
public Name analysis(ResourceReference analysis)
```
    Description copied from class: Conclusion
    
    Add a reference to the analysis for this conclusion.
    
    Overrides:
    
    analysis in class Conclusion
    
    Parameters:
    
    analysis - The analysis.
    
    Returns:
    
    this.
  - analysis
```
public Name analysis(Document analysis)
```
    Description copied from class: Conclusion
    
    Add a reference to the analysis for this conclusion.
    
    Overrides:
    
    analysis in class Conclusion
    
    Parameters:
    
    analysis - The analysis.
    
    Returns:
    
    this.
  - analysis
```
public Name analysis(URI analysis)
```
    Description copied from class: Conclusion
    
    Add a reference to the analysis for this conclusion.
    
    Overrides:
    
    analysis in class Conclusion
    
    Parameters:
    
    analysis - The analysis.
    
    Returns:
    
    this.
  - sortKey
```
public Name sortKey(String sortKey)
```
    Description copied from class: Conclusion
    
    Build up this fact with a sort key.
    
    Overrides:
    
    sortKey in class Conclusion
    
    Parameters:
    
    sortKey - The sort key.
    
    Returns:
    
    this.
  - getType
```
public URI getType()
```
    The type of the name.
    
    Returns:
    
    The type of the name.
  - setType
```
public void setType(URI type)
```
    The type of the name.
    
    Parameters:
    
    type - The type of the name.
  - type
```
public Name type(URI type)
```
    Build up this name with a type.
    
    Parameters:
    
    type - The type.
    
    Returns:
    
    this.
  - type
```
public Name type(NameType type)
```
    Build up this name with a type.
    
    Parameters:
    
    type - The type.
    
    Returns:
    
    this.
  - getKnownType
```
public NameType getKnownType()
```
    The enum referencing the known name type, or NameType.OTHER if not known.
    
    Returns:
    
    The enum referencing the known name type, or NameType.OTHER if not known.
  - setKnownType
```
public void setKnownType(NameType knownType)
```
    Set the name type from an enumeration of known name types.
    
    Parameters:
    
    knownType - The known type.
  - getDate
```
public Date getDate()
```
    The date the name was first applied or adopted.
    
    Returns:
    
    The date the name was first applied or adopted.
  - setDate
```
public void setDate(Date date)
```
    The date the name was first applied or adopted.
    
    Parameters:
    
    date - The date the name was first applied or adopted.
  - date
```
public Name date(Date date)
```
    Build up this name with a date.
    
    Parameters:
    
    date - The date.
    
    Returns:
    
    this.
  - getNameForms
```
public List<NameForm> getNameForms()
```
    Alternate forms of the name, such as the romanized form of a non-latin name.
    
    Returns:
    
    Alternate forms of the name, such as the romanized form of a non-latin name.
  - getNameForm
```
public NameForm getNameForm()
```
    The first name form of this name.
    
    Returns:
    
    The first name form of this name.
  - setNameForms
```
public void setNameForms(List<NameForm> nameForms)
```
    Alternate forms of the name, such as the romanized form of a non-latin name.
    
    Parameters:
    
    nameForms - Alternate forms of the name, such as the romanized form of a non-latin name.
  - nameForm
```
public Name nameForm(NameForm nameForm)
```
    Build up this name with a name form.
    
    Parameters:
    
    nameForm - The name form.
    
    Returns:
    
    this.
  - addNameForm
```
public void addNameForm(NameForm nameForm)
```
    Add a name form to the list of name forms.
    
    Parameters:
    
    nameForm - The name form to be added.
  - getPreferred
```
public Boolean getPreferred()
```
    Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes.
    
    Returns:
    
    Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes.
  - setPreferred
```
public void setPreferred(Boolean preferred)
```
    Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes.
    
    Parameters:
    
    preferred - Whether the conclusion is preferred above other conclusions of the same type. Useful, for example, for display purposes.
  - preferred
```
public Name preferred(Boolean preferred)
```
    Build up this name with a preferred flag.
    
    Parameters:
    
    preferred - The preferred flag.
    
    Returns:
    
    this.
  - getPart
```
public String getPart(NamePartType namePartType)
```
    Gets a specific part of the name
    
    Parameters:
    
    namePartType - specific part of the name to retrieve
    
    Returns:
    
    the specific part of the name that matches the given NamePartType
  - toString
```
public String toString()
```
    Description copied from class: Conclusion
    
    Provide a simple toString() method.
    
    Overrides:
    
    toString in class Conclusion
  - accept
```
public void accept(GedcomxModelVisitor visitor)
```
    Accept a visitor.
    
    Parameters:
    
    visitor - The visitor.

Class Name

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

Constructor Summary

Method Summary

Methods inherited from class org.gedcomx.conclusion.Conclusion

Methods inherited from class org.gedcomx.links.HypermediaEnabledData

Methods inherited from class org.gedcomx.common.ExtensibleData

Methods inherited from class java.lang.Object

Constructor Detail

Name

Name

Method Detail

id

extensionElement

link

link

lang

confidence

confidence

source

source

note

attribution

analysis

analysis

analysis

sortKey

getType

setType

type

type

getKnownType

setKnownType

getDate

setDate

date

getNameForms

getNameForm

setNameForms

nameForm

addNameForm

getPreferred

setPreferred

preferred

getPart

toString

accept