Package org.gedcomx.links

Class HypermediaEnabledData

java.lang.Object
org.gedcomx.common.ExtensibleData
org.gedcomx.links.HypermediaEnabledData
All Implemented Interfaces:
HasTransientProperties, SupportsLinks, SupportsExtensionElements
Direct Known Subclasses:
Agent, Collection, CollectionContent, Conclusion, Coverage, EvidenceReference, FamilyView, FieldDescriptor, FieldValueDescriptor, Gedcomx, Note, RecordDescriptor, RecordSet, SourceCitation, SourceDescription, SourceReference
public abstract class HypermediaEnabledData extends ExtensibleData implements SupportsLinks
An data type that supports hypermedia controls (i.e. links).
Author:
Ryan Heaton

  • Constructor Details

    • HypermediaEnabledData

      protected HypermediaEnabledData()

    • HypermediaEnabledData

      protected HypermediaEnabledData(HypermediaEnabledData copy)

  • Method Details

    • getLinks

      public List<Link> getLinks()
      The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
      Specified by:
      getLinks in interface SupportsLinks
      Returns:
      The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

    • setLinks

      public 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.
      Specified by:
      setLinks in interface SupportsLinks
      Parameters:
      links - The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

    • link

      public HypermediaEnabledData link(Link link)
      Build up this data with a link.
      Parameters:
      link - The link.
      Returns:
      this.

    • link

      public HypermediaEnabledData link(String rel, URI href)
      Build up this data with a link.
      Parameters:
      rel - The rel.
      href - The href.
      Returns:
      this.

    • addLink

      public void addLink(Link link)
      Add a hypermedia link. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.
      Specified by:
      addLink in interface SupportsLinks
      Parameters:
      link - The hypermedia link. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS.

    • addLink

      public void addLink(String rel, URI href)
      Add a hypermedia link.
      Specified by:
      addLink in interface SupportsLinks
      Parameters:
      rel - The link rel.
      href - The target URI.

    • addTemplatedLink

      public void addTemplatedLink(String rel, String template)
      Add a templated link.
      Specified by:
      addTemplatedLink in interface SupportsLinks
      Parameters:
      rel - The link rel.
      template - The link template.

    • getLink

      public 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.
      Specified by:
      getLink in interface SupportsLinks
      Parameters:
      rel - The link rel.
      Returns:
      The link by rel.

    • getLinks

      public 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.
      Specified by:
      getLinks in interface SupportsLinks
      Parameters:
      rel - The rel of the links.
      Returns:
      The link.

    • embed

      protected void embed(HypermediaEnabledData data)