org.gedcomx.conclusion
Class DisplayProperties

java.lang.Object
  org.gedcomx.common.ExtensibleData
      org.gedcomx.conclusion.DisplayProperties

All Implemented Interfaces:

HasTransientProperties, SupportsExtensionElements

public class DisplayProperties
extends ExtensibleData

A set of display properties for the convenience of quick display, such as for a Web-based application. All display properties are provided in the default locale for the current application context and are NOT considered canonical for the purposes of data exchange.

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

DisplayProperties()

Method Summary

void	addFamilyAsChild(FamilyView family) Add a family where this person is a child to the data set.
void	addFamilyAsParent(FamilyView family) Add a family where this person is a parent
DisplayProperties	ascendancyNumber(String ascendancynumber) Build up these properties with a ascendancy number.
DisplayProperties	birthDate(String birthdate) Build up these properties with a birth date.
DisplayProperties	birthPlace(String birthplace) Build up these properties with a birth place.
DisplayProperties	deathDate(String deathdate) Build up these properties with a death date.
DisplayProperties	deathPlace(String deathplace) Build up these properties with a death place.
DisplayProperties	descendancyNumber(String descendancynumber) Build up these properties with a descendancy number.
void	embed(DisplayProperties data) Embed a set of display properties.
DisplayProperties	gender(String gender) Build up these properties with a gender.
String	getAscendancyNumber() The context-specific ascendancy number for the person in relation to the other persons in the request.
String	getBirthDate() The displayable label for the birth date of the person.
String	getBirthPlace() The displayable label for the birth place of the person.
String	getDeathDate() The displayable label for the death date of the person.
String	getDeathPlace() The displayable label for the death place of the person.
String	getDescendancyNumber() The context-specific descendancy number for the person in relation to the other persons in the request.
List<FamilyView>	getFamiliesAsChild() The family views where this person is a child
List<FamilyView>	getFamiliesAsParent() The family views where this person is a parent
String	getGender() The displayable label for the gender of the person.
String	getLifespan() The displayable label for the lifespan of the person.
String	getMarriageDate() The displayable label for the marriage date of the person.
String	getMarriagePlace() The displayable label for the marriage place of the person.
String	getName() The displayable name of the person.
DisplayProperties	id(String id) Build up this object with an id.
DisplayProperties	lifespan(String lifespan) Build up these properties with a lifespan.
DisplayProperties	marriageDate(String marriagedate) Build up these properties with a marriage date.
DisplayProperties	marriagePlace(String marriageplace) Build up these properties with a marriage place.
DisplayProperties	name(String name) Build up these properties with a name.
void	setAscendancyNumber(String ascendancyNumber) The context-specific ascendancy number for the person in relation to the other persons in the request.
void	setBirthDate(String birthDate) The displayable label for the birth date of the person.
void	setBirthPlace(String birthPlace) The displayable label for the birth place of the person.
void	setDeathDate(String deathDate) The displayable label for the death date of the person.
void	setDeathPlace(String deathPlace) The displayable label for the death place of the person.
void	setDescendancyNumber(String descendancyNumber) The context-specific descendancy number for the person in relation to the other persons in the request.
void	setFamiliesAsChild(List<FamilyView> familiesAsChild) The family views where this person is a child
void	setFamiliesAsParent(List<FamilyView> familiesAsParent) The family views where this person is a parent
void	setGender(String gender) Displayable form of the gender.
void	setLifespan(String lifespan) The displayable label for the lifespan of the person.
void	setMarriageDate(String marriageDate) The displayable label for the marriage date of the person.
void	setMarriagePlace(String marriagePlace) The displayable label for the marriage place of the person.
void	setName(String name) The displayable name of the person.

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

Constructor Detail

DisplayProperties

public DisplayProperties()

Method Detail

id

public DisplayProperties id(String id)

Description copied from class: ExtensibleData

Build up this object with an id.

Overrides:

id in class ExtensibleData

Parameters:

id - The id.

getName

public String getName()

The displayable name of the person.

Returns:

The displayable name of the person.

setName

public void setName(String name)

The displayable name of the person.

Parameters:

name - The displayable name of the person.

name

public DisplayProperties name(String name)

Build up these properties with a name.

Parameters:

name - The name.

Returns:

this.

getGender

public String getGender()

The displayable label for the gender of the person.

Returns:

The displayable label for the gender of the person.

setGender

public void setGender(String gender)

Displayable form of the gender.

Parameters:

gender - Displayable form of the gender.

gender

public DisplayProperties gender(String gender)

Build up these properties with a gender.

Parameters:

gender - The gender.

Returns:

this.

getLifespan

public String getLifespan()

The displayable label for the lifespan of the person.

Returns:

The displayable label for the lifespan of the person.

setLifespan

public void setLifespan(String lifespan)

The displayable label for the lifespan of the person.

Parameters:

lifespan - The displayable label for the lifespan of the person.

lifespan

public DisplayProperties lifespan(String lifespan)

Build up these properties with a lifespan.

Parameters:

lifespan - The lifespan.

Returns:

this.

getBirthDate

public String getBirthDate()

The displayable label for the birth date of the person.

Returns:

The displayable label for the birth date of the person.

setBirthDate

public void setBirthDate(String birthDate)

The displayable label for the birth date of the person.

Parameters:

birthDate - The displayable label for the birth date of the person.

birthDate

public DisplayProperties birthDate(String birthdate)

Build up these properties with a birth date.

Parameters:

birthdate - The birth date.

Returns:

this.

getBirthPlace

public String getBirthPlace()

The displayable label for the birth place of the person.

Returns:

The displayable label for the birth place of the person.

setBirthPlace

public void setBirthPlace(String birthPlace)

The displayable label for the birth place of the person.

Parameters:

birthPlace - The displayable label for the birth place of the person.

birthPlace

public DisplayProperties birthPlace(String birthplace)

Build up these properties with a birth place.

Parameters:

birthplace - The birth place.

Returns:

this.

getDeathDate

public String getDeathDate()

The displayable label for the death date of the person.

Returns:

The displayable label for the death date of the person.

setDeathDate

public void setDeathDate(String deathDate)

The displayable label for the death date of the person.

Parameters:

deathDate - The displayable label for the death date of the person.

deathDate

public DisplayProperties deathDate(String deathdate)

Build up these properties with a death date.

Parameters:

deathdate - The death date.

Returns:

this.

getDeathPlace

public String getDeathPlace()

The displayable label for the death place of the person.

Returns:

The displayable label for the death place of the person.

setDeathPlace

public void setDeathPlace(String deathPlace)

The displayable label for the death place of the person.

Parameters:

deathPlace - The displayable label for the death place of the person.

deathPlace

public DisplayProperties deathPlace(String deathplace)

Build up these properties with a death place.

Parameters:

deathplace - The death place.

Returns:

this.

getMarriageDate

public String getMarriageDate()

The displayable label for the marriage date of the person.

Returns:

The displayable label for the marriage date of the person.

setMarriageDate

public void setMarriageDate(String marriageDate)

The displayable label for the marriage date of the person.

Parameters:

marriageDate - The displayable label for the marriage date of the person.

marriageDate

public DisplayProperties marriageDate(String marriagedate)

Build up these properties with a marriage date.

Parameters:

marriagedate - The marriage date.

Returns:

this.

getMarriagePlace

public String getMarriagePlace()

The displayable label for the marriage place of the person.

Returns:

The displayable label for the marriage place of the person.

setMarriagePlace

public void setMarriagePlace(String marriagePlace)

The displayable label for the marriage place of the person.

Parameters:

marriagePlace - The displayable label for the marriage place of the person.

marriagePlace

public DisplayProperties marriagePlace(String marriageplace)

Build up these properties with a marriage place.

Parameters:

marriageplace - The marriage place.

Returns:

this.

getAscendancyNumber

public String getAscendancyNumber()

The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system.

Returns:

The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system.

setAscendancyNumber

public void setAscendancyNumber(String ascendancyNumber)

The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system.

Parameters:

ascendancyNumber - The context-specific ascendancy number for the person in relation to the other persons in the request. The ancestry number is defined using the Ahnentafel numbering system.

ascendancyNumber

public DisplayProperties ascendancyNumber(String ascendancynumber)

Build up these properties with a ascendancy number.

Parameters:

ascendancynumber - The ascendancy number.

Returns:

this.

getDescendancyNumber

public String getDescendancyNumber()

The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system.

Returns:

The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system.

setDescendancyNumber

public void setDescendancyNumber(String descendancyNumber)

The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system.

Parameters:

descendancyNumber - The context-specific descendancy number for the person in relation to the other persons in the request. The descendancy number is defined using the d'Aboville numbering system.

descendancyNumber

public DisplayProperties descendancyNumber(String descendancynumber)

Build up these properties with a descendancy number.

Parameters:

descendancynumber - The descendancy number.

Returns:

this.

getFamiliesAsParent

public List<FamilyView> getFamiliesAsParent()

The family views where this person is a parent

Returns:

The family views where this person is a parent.

setFamiliesAsParent

public void setFamiliesAsParent(List<FamilyView> familiesAsParent)

The family views where this person is a parent

Parameters:

familiesAsParent - The families where this person is a parent

addFamilyAsParent

public void addFamilyAsParent(FamilyView family)

Add a family where this person is a parent

Parameters:

family - The family where this person is a parent

getFamiliesAsChild

public List<FamilyView> getFamiliesAsChild()

The family views where this person is a child

Returns:

The family views where this person is a child

setFamiliesAsChild

public void setFamiliesAsChild(List<FamilyView> familiesAsChild)

The family views where this person is a child

Parameters:

familiesAsChild - The families where this person is a child

addFamilyAsChild

public void addFamilyAsChild(FamilyView family)

Add a family where this person is a child to the data set.

Parameters:

family - The family to be added.

embed

public void embed(DisplayProperties data)

Embed a set of display properties.

Parameters:

data - The data to embed.