Package org.gedcomx.links

Interface SupportsLinks

All Known Implementing Classes:

Agent, Collection, CollectionContent, Conclusion, Coverage, Document, Event, EventRole, EvidenceReference, Fact, FamilyView, Field, FieldDescriptor, FieldValue, FieldValueDescriptor, Gedcomx, Gender, HypermediaEnabledData, Name, Note, Person, PlaceDescription, RecordDescriptor, RecordSet, Relationship, SourceCitation, SourceDescription, SourceReference, Subject

public interface SupportsLinks

Author:

Ryan Heaton

Method Summary

Modifier and Type	Method	Description
void	addLink(String rel, URI href)	Add a hypermedia link.
void	addLink(Link link)	Add a hypermedia link.
void	addTemplatedLink(String rel, String template)	Add a templated link.
Link	getLink(String rel)	Get a link by its rel.
List<Link>	getLinks()	The list of hypermedia links.
List<Link>	getLinks(String rel)	Get a list of links by rel.
void	setLinks(List<Link> links)	The list of hypermedia links.

Method Detail

getLinks

List<Link> getLinks()

The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Returns:

The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

setLinks

void setLinks(List<Link> links)

The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Parameters:

links - The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

addLink

void addLink(Link link)

Add a hypermedia link. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Parameters:

link - The hypermedia link. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

addLink

void addLink(String rel,
             URI href)

Add a hypermedia link.

Parameters:

rel - The link rel.

href - The target URI.

addTemplatedLink

void addTemplatedLink(String rel,
                      String template)

Add a templated link.

Parameters:

rel - The link rel.

template - The link template.

getLink

Link getLink(String rel)

Get a link by its rel. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Parameters:

rel - The link rel.

Returns:

The link by rel.

getLinks

List<Link> getLinks(String rel)

Get a list of links by rel. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

Parameters:

rel - The rel of the links.

Returns:

The link.