org.gedcomx.conclusion
Class PlaceDisplayProperties

java.lang.Object
  extended by org.gedcomx.common.ExtensibleData
      extended by org.gedcomx.conclusion.PlaceDisplayProperties
All Implemented Interfaces:
HasTransientProperties, SupportsExtensionElements

public class PlaceDisplayProperties
extends ExtensibleData

A set of display properties for places 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
PlaceDisplayProperties()
           
 
Method Summary
 void embed(PlaceDisplayProperties data)
          Embed a set of display properties.
 PlaceDisplayProperties fullName(String name)
          Build up these properties with a full name.
 String getFullName()
          The displayable full name of the place.
 String getName()
          The displayable name of the place.
 String getType()
          The displayable type of the place.
 PlaceDisplayProperties id(String id)
          Build up this object with an id.
 PlaceDisplayProperties name(String name)
          Build up these properties with a name.
 void setFullName(String name)
          The displayable full name of the place.
 void setName(String name)
          The displayable name of the place.
 void setType(String type)
          The displayable type of the place.
 PlaceDisplayProperties type(String type)
          Build up these properties with a type.
 
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

PlaceDisplayProperties

public PlaceDisplayProperties()
Method Detail

id

public PlaceDisplayProperties 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 place.

Returns:
The displayable name of the place.

setName

public void setName(String name)
The displayable name of the place.

Parameters:
name - The displayable name of the place.

name

public PlaceDisplayProperties name(String name)
Build up these properties with a name.

Parameters:
name - The name.
Returns:
this.

getFullName

public String getFullName()
The displayable full name of the place.

Returns:
The displayable full name of the place.

setFullName

public void setFullName(String name)
The displayable full name of the place.

Parameters:
name - The displayable full name of the place.

fullName

public PlaceDisplayProperties fullName(String name)
Build up these properties with a full name.

Parameters:
name - The name.
Returns:
this.

getType

public String getType()
The displayable type of the place.

Returns:
The displayable type of the place.

setType

public void setType(String type)
The displayable type of the place.

Parameters:
type - The displayable type of the place.

type

public PlaceDisplayProperties type(String type)
Build up these properties with a type.

Parameters:
type - The type.
Returns:
this.

embed

public void embed(PlaceDisplayProperties data)
Embed a set of display properties.

Parameters:
data - The data to embed.


Copyright © 2015. All rights reserved.