org.gedcomx.common

Class Attribution

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.common.Attribution

All Implemented Interfaces:

HasTransientProperties, SupportsExtensionElements

public final class Attribution
extends ExtensibleData

Attribution for genealogical information. Attribution is used to model who is contributing/modifying information, when they contributed it, and why they are making the contribution/modification.

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor and Description
Attribution()

Method Summary

Modifier and Type	Method and Description
Attribution	changeMessage(String changeMessage) Build up this attribution with a change message.
Attribution	contributor(Agent agent) Build up this attribution with a contributor.
Attribution	contributor(ResourceReference contributor) Build up this attribution with a contributor.
Attribution	contributor(URI contributor) Build up this attribution with a contributor.
Attribution	created(Date created) Build up this attribution with a created date.
Attribution	creator(Agent agent) Build up this attribution with a creator.
Attribution	creator(ResourceReference creator) Build up this attribution with a creator.
Attribution	creator(URI creator) Build up this attribution with a creator.
Attribution	extensionElement(Object element)
String	getChangeMessage() The "change message" for the attributed data provided by the contributor.
ResourceReference	getContributor() Reference to the contributor of the attributed data.
Date	getCreated() The created timestamp for the attributed data.
ResourceReference	getCreator() Reference to the creator of the attributed data.
Date	getModified() The modified timestamp for the attributed data.
Attribution	id(String id) Build up this object with an id.
Attribution	modified(Date modified) Build up this attribution with a modified date.
void	setChangeMessage(String changeMessage) The "change message" for the attributed data provided by the contributor.
void	setContributor(ResourceReference contributor) Reference to the contributor of the attributed data.
void	setCreated(Date created) The created timestamp for the attributed data.
void	setCreator(ResourceReference creator) Reference to the creator of the attributed data.
void	setModified(Date modified) The modified timestamp for the attributed data.
String	toString() Provide a simple toString() method.

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

Attribution

public Attribution()

Method Detail

id

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

Overrides:

extensionElement in class ExtensibleData

getContributor

public ResourceReference getContributor()

Reference to the contributor of the attributed data.

Returns:

Reference to the contributor of the attributed data.

setContributor

public void setContributor(ResourceReference contributor)

Reference to the contributor of the attributed data.

Parameters:

contributor - Reference to the contributor of the attributed data.

contributor

public Attribution contributor(ResourceReference contributor)

Build up this attribution with a contributor.

Parameters:

contributor - The contributor.

Returns:

this.

contributor

public Attribution contributor(URI contributor)

Build up this attribution with a contributor.

Parameters:

contributor - The contributor.

Returns:

this.

contributor

public Attribution contributor(Agent agent)

Build up this attribution with a contributor.

Parameters:

agent - The contributor.

Returns:

this.

getCreator

public ResourceReference getCreator()

Reference to the creator of the attributed data. The creator might be different from the contributor if the attributed data has been modified since it was created.

Returns:

Reference to the creator of the attributed data.

setCreator

public void setCreator(ResourceReference creator)

Reference to the creator of the attributed data. The creator might be different from the contributor if the attributed data has been modified since it was created.

Parameters:

creator - Reference to the creator of the attributed data.

creator

public Attribution creator(ResourceReference creator)

Build up this attribution with a creator.

Parameters:

creator - The creator.

Returns:

this.

creator

public Attribution creator(URI creator)

Build up this attribution with a creator.

Parameters:

creator - The creator.

Returns:

this.

creator

public Attribution creator(Agent agent)

Build up this attribution with a creator.

Parameters:

agent - The creator.

Returns:

this.

getModified

public Date getModified()

The modified timestamp for the attributed data.

Returns:

The modified timestamp for the attributed data.

setModified

public void setModified(Date modified)

The modified timestamp for the attributed data.

Parameters:

modified - The modified timestamp for the attributed data.

modified

public Attribution modified(Date modified)

Build up this attribution with a modified date.

Parameters:

modified - The modified date.

Returns:

this.

getCreated

public Date getCreated()

The created timestamp for the attributed data.

Returns:

The created timestamp for the attributed data.

setCreated

public void setCreated(Date created)

The created timestamp for the attributed data.

Parameters:

created - The created timestamp for the attributed data.

created

public Attribution created(Date created)

Build up this attribution with a created date.

Parameters:

created - The created date.

Returns:

this.

getChangeMessage

public String getChangeMessage()

The "change message" for the attributed data provided by the contributor.

Returns:

The "change message" for the attributed data provided by the contributor.

setChangeMessage

public void setChangeMessage(String changeMessage)

The "change message" for the attributed data provided by the contributor.

Parameters:

changeMessage - The "change message" for the attributed data provided by the contributor.

changeMessage

public Attribution changeMessage(String changeMessage)

Build up this attribution with a change message.

Parameters:

changeMessage - The change message.

Returns:

this.

toString

public String toString()

Provide a simple toString() method.

Overrides:

toString in class ExtensibleData