Package org.gedcomx.conclusion

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

    • Constructor Detail

      • DisplayProperties

        public DisplayProperties()

    • Method Detail

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

      • getRelationshipDescription

        public String getRelationshipDescription()
        The context-specific relationship description for the person in relation to the root person in the request.
        Returns:
        The context-specific relationship description for the person in relation to the root person in the request.

      • setRelationshipDescription

        public void setRelationshipDescription​(String relationshipDescription)
        The context-specific relationship description for the person in relation to the root person in the request.
        Parameters:
        relationshipDescription - The context-specific relationship description for the person in relation to the root person in the request.

      • relationship

        public DisplayProperties relationship​(String relationshipDescription)
        Build up these properties with a relationship description.
        Parameters:
        relationshipDescription - The relationship description.
        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.

      • getRole

        public String getRole()
        The role of this person in the current display context.
        Returns:
        The role of this person in the current display context.

      • setRole

        public void setRole​(String role)
        The role of this person in the current display context.
        Parameters:
        role - The role of this person in the current display context.

      • embed

        public void embed​(DisplayProperties data)
        Embed a set of display properties.
        Parameters:
        data - The data to embed.