org.gedcomx.common

Class Note

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.links.HypermediaEnabledData

org.gedcomx.common.Note

All Implemented Interfaces:

Attributable, HasText, HasTransientProperties, SupportsLinks, SupportsExtensionElements

public class Note
extends HypermediaEnabledData
implements Attributable, HasText

A note about a genealogical resource (e.g. conclusion or source).

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor and Description
Note()

Method Summary

Modifier and Type	Method and Description
void	accept(GedcomxModelVisitor visitor) Accept a visitor.
Note	attribution(Attribution attribution) Build up this note with attribution.
Note	extensionElement(Object element)
Attribution	getAttribution() Attribution metadata for a note.
String	getLang() The language of the note.
String	getSubject() The subject of the note.
String	getText() The text of the note.
Note	id(String id) Build up this object with an id.
Note	lang(String lang) Build up this note with a locale.
Note	link(Link link) Build up this data with a link.
Note	link(String rel, URI href) Build up this data with a link.
void	setAttribution(Attribution attribution) Attribution metadata for a note.
void	setLang(String lang) The language of the note.
void	setSubject(String text) The subject of the note.
void	setText(String text) The text of the note.
Note	subject(String text) Build up this note with a subject.
Note	text(String text) Build up this note with some text.
String	toString() Provide a simple toString() method.

Methods inherited from class org.gedcomx.links.HypermediaEnabledData

addLink, addLink, addTemplatedLink, embed, getLink, getLinks, getLinks, setLinks

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

Note

public Note()

Method Detail

id

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

Overrides:

extensionElement in class ExtensibleData

link

public Note link(String rel,
                 URI href)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class HypermediaEnabledData

Parameters:

rel - The rel.

href - The href.

Returns:

this.

link

public Note link(Link link)

Description copied from class: HypermediaEnabledData

Build up this data with a link.

Overrides:

link in class HypermediaEnabledData

Parameters:

link - The link.

Returns:

this.

getLang

public String getLang()

The language of the note. See http://www.w3.org/International/articles/language-tags/

Returns:

The language of the note.

setLang

public void setLang(String lang)

The language of the note. See http://www.w3.org/International/articles/language-tags/

Parameters:

lang - The language of the note.

lang

public Note lang(String lang)

Build up this note with a locale.

Parameters:

lang - The locale.

Returns:

this.

getSubject

public String getSubject()

The subject of the note. This is a short title describing the contents of the note text.

Returns:

The subject of the note.

setSubject

public void setSubject(String text)

The subject of the note.

Parameters:

text - The subject of the note.

subject

public Note subject(String text)

Build up this note with a subject.

Parameters:

text - The subject.

Returns:

this.

getText

public String getText()

The text of the note.

Specified by:

getText in interface HasText

Returns:

The text of the note.

setText

public void setText(String text)

The text of the note.

Specified by:

setText in interface HasText

Parameters:

text - The text of the note.

text

public Note text(String text)

Build up this note with some text.

Parameters:

text - The text.

Returns:

this.

getAttribution

public Attribution getAttribution()

Attribution metadata for a note.

Specified by:

getAttribution in interface Attributable

Returns:

Attribution metadata for a note.

setAttribution

public void setAttribution(Attribution attribution)

Attribution metadata for a note.

Specified by:

setAttribution in interface Attributable

Parameters:

attribution - Attribution metadata for a note.

attribution

public Note attribution(Attribution attribution)

Build up this note with attribution.

Parameters:

attribution - The attribution.

Returns:

this.

toString

public String toString()

Description copied from class: ExtensibleData

Provide a simple toString() method.

Overrides:

toString in class ExtensibleData

accept

public void accept(GedcomxModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor.