Package org.gedcomx.records

Class RecordSet

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.links.HypermediaEnabledData

org.gedcomx.records.RecordSet

All Implemented Interfaces:

HasTransientProperties, SupportsLinks, SupportsExtensionElements

public class RecordSet
extends HypermediaEnabledData

The GEDCOM X bulk record data formats are used to exchange bulk genealogical data sets, grouped into records.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor	Description
RecordSet()

Method Summary

Modifier and Type	Method	Description
RecordSet	extensionElement(Object element)
String	getLang()	The language of this genealogical data set.
Gedcomx	getMetadata()	Metadata about this record set; shared among all records in the set.
List<Gedcomx>	getRecords()	The records included in this genealogical data set.
RecordSet	id(String id)	Build up this object with an id.
RecordSet	lang(String lang)	Build out this record set with a lang.
RecordSet	link(String rel, URI href)	Build up this data with a link.
RecordSet	link(Link link)	Build up this data with a link.
RecordSet	metadata(Gedcomx metadata)	Build out this record set with metadata.
RecordSet	record(Gedcomx record)	Build out this record set with a record.
Stream<Gedcomx>	records()	Create a stream for the records.
void	setLang(String lang)	The language of this genealogical data set.
void	setMetadata(Gedcomx metadata)	Metadata about this record set; shared among all records in the set.
void	setRecords(List<Gedcomx> records)	The records included in this genealogical data set.

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, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RecordSet

public RecordSet()

Method Detail

id

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

Overrides:

extensionElement in class ExtensibleData

link

public RecordSet 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 RecordSet 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 this genealogical data set. See http://www.w3.org/International/articles/language-tags/. Note that some language-enabled elements MAY override the language.

Returns:

The language of the genealogical data.

setLang

public void setLang(String lang)

The language of this genealogical data set. See http://www.w3.org/International/articles/language-tags/. Note that some language-enabled elements MAY override the language.

Parameters:

lang - The language of this genealogical data.

lang

public RecordSet lang(String lang)

Build out this record set with a lang.

Parameters:

lang - The lang.

Returns:

this.

getMetadata

public Gedcomx getMetadata()

Metadata about this record set; shared among all records in the set.

Returns:

Metadata about this record set; shared among all records in the set.

setMetadata

public void setMetadata(Gedcomx metadata)

Metadata about this record set; shared among all records in the set.

Parameters:

metadata - Metadata about this record set; shared among all records in the set.

metadata

public RecordSet metadata(Gedcomx metadata)

Build out this record set with metadata.

Parameters:

metadata - The metadata.

Returns:

this.

records

public Stream<Gedcomx> records()

Create a stream for the records.

Returns:

a stream for the records.

getRecords

public List<Gedcomx> getRecords()

The records included in this genealogical data set.

Returns:

The records included in this genealogical data set.

setRecords

public void setRecords(List<Gedcomx> records)

The records included in this genealogical data set.

Parameters:

records - The records included in this genealogical data set.

record

public RecordSet record(Gedcomx record)

Build out this record set with a record.

Parameters:

record - The record.

Returns:

this.