Package org.gedcomx.conclusion

Class NameForm

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.conclusion.NameForm

All Implemented Interfaces:

HasTransientProperties, HasFields, SupportsExtensionElements

public class NameForm
extends ExtensibleData
implements HasFields

A form of a name.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor	Description
NameForm()
NameForm(String fullText, NamePart... parts)

Method Summary

Modifier and Type	Method	Description
void	accept(GedcomxModelVisitor visitor)	Accept a visitor.
void	addField(Field field)	Add a reference to the record field values being used as evidence.
void	addPart(NamePart part)	Add a name part the list of name parts for this name form.
NameForm	extensionElement(Object element)
NameForm	field(Field field)	Build up this name form with a field.
NameForm	fullText(String fullText)	Build up this name form with full text.
List<Field>	getFields()	Get the fields being used as evidence.
String	getFullText()	The full text of the name form.
String	getLang()	The language of the conclusion.
List<NamePart>	getParts()	The different parts of the name form.
NameForm	id(String id)	Build up this object with an id.
NameForm	lang(String lang)	Build up this name form with a lang.
NameForm	part(NamePart part)	Build up this name form with a part.
NameForm	part(NamePartType partType, String value)	Build up this name form with a part.
Stream<NamePart>	parts()	Create a stream for the name parts.
void	setFields(List<Field> fields)	Set the list of fields being used as evidence.
void	setFullText(String fullText)	The full text of the name form.
void	setLang(String lang)	The language of the conclusion.
void	setParts(List<NamePart> parts)	The different parts of the name form.

Methods inherited from class org.gedcomx.common.ExtensibleData

addExtensionElement, embed, findExtensionOfType, findExtensionOfType, findExtensionsOfType, findExtensionsOfType, getExtensionElements, getId, getTransientProperties, getTransientProperty, removeExtensionElements, setExtensionElement, setExtensionElements, setId, setTransientProperty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.gedcomx.records.HasFields

fields

Constructor Detail

NameForm

public NameForm()

NameForm

public NameForm(String fullText,
                NamePart... parts)

Method Detail

id

public NameForm 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 NameForm extensionElement(Object element)

Overrides:

extensionElement in class ExtensibleData

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 NameForm lang(String lang)

Build up this name form with a lang.

Parameters:

lang - The lang.

Returns:

this.

getFullText

public String getFullText()

The full text of the name form.

Returns:

The full text of the name form.

setFullText

public void setFullText(String fullText)

The full text of the name form.

Parameters:

fullText - The full text of the name form.

fullText

public NameForm fullText(String fullText)

Build up this name form with full text.

Parameters:

fullText - The full text.

Returns:

this

parts

public Stream<NamePart> parts()

Create a stream for the name parts.

Returns:

a stream for the name parts.

getParts

public List<NamePart> getParts()

The different parts of the name form.

Returns:

The different parts of the name form.

setParts

public void setParts(List<NamePart> parts)

The different parts of the name form.

Parameters:

parts - The different parts of the name form.

part

public NameForm part(NamePart part)

Build up this name form with a part.

Parameters:

part - The part.

Returns:

this.

part

public NameForm part(NamePartType partType,
                     String value)

Build up this name form with a part.

Parameters:

partType - The part type.

value - The value.

Returns:

this.

addPart

public void addPart(NamePart part)

Add a name part the list of name parts for this name form.

Parameters:

part - The name part to be added.

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 NameForm field(Field field)

Build up this name form 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.

accept

public void accept(GedcomxModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor.