Package org.gedcomx.records

Class RecordDescriptor

java.lang.Object

org.gedcomx.common.ExtensibleData

org.gedcomx.links.HypermediaEnabledData

org.gedcomx.records.RecordDescriptor

All Implemented Interfaces:

HasTransientProperties, SupportsLinks, SupportsExtensionElements

public class RecordDescriptor
extends HypermediaEnabledData

A descriptor for a common set of records.

Author:

Ryan Heaton

Field Summary

Fields inherited from class org.gedcomx.common.ExtensibleData

extensionElements, transientProperties

Constructor Summary

Constructors

Constructor	Description
RecordDescriptor()

Method Summary

Modifier and Type	Method	Description
void	accept(GedcomxModelVisitor visitor)	Accept a visitor.
void	embed(RecordDescriptor recordDescriptor)	Embed another record descriptor.
Stream<FieldDescriptor>	fields()	Create a stream for the fields.
List<FieldDescriptor>	getFields()	Descriptors of the fields that are applicable to this record.
String	getLang()	The language of this record description.
void	setFields(List<FieldDescriptor> fields)	Descriptors of the fields that are applicable to this record.
void	setLang(String lang)	The language of this record description.

Methods inherited from class org.gedcomx.links.HypermediaEnabledData

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

Methods inherited from class org.gedcomx.common.ExtensibleData

addExtensionElement, embed, extensionElement, findExtensionOfType, findExtensionOfType, findExtensionsOfType, findExtensionsOfType, getExtensionElements, getId, getTransientProperties, getTransientProperty, id, 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

RecordDescriptor

public RecordDescriptor()

Method Detail

getLang

public String getLang()

The language of this record description. See http://www.w3.org/International/articles/language-tags/

Returns:

The language of this record description.

setLang

public void setLang(String lang)

The language of this record description. See http://www.w3.org/International/articles/language-tags/

Parameters:

lang - The language of this record description.

fields

public Stream<FieldDescriptor> fields()

Create a stream for the fields.

Returns:

a stream for the fields.

getFields

public List<FieldDescriptor> getFields()

Descriptors of the fields that are applicable to this record.

Returns:

Descriptors of the fields that are applicable to this record.

setFields

public void setFields(List<FieldDescriptor> fields)

Descriptors of the fields that are applicable to this record.

Parameters:

fields - Descriptors of the fields that are applicable to this record.

accept

public void accept(GedcomxModelVisitor visitor)

Accept a visitor.

Parameters:

visitor - The visitor.

embed

public void embed(RecordDescriptor recordDescriptor)

Embed another record descriptor.

Parameters:

recordDescriptor - The descriptor to embed.