Package io.goobi.viewer.servlets.oembed

Class OEmbedRecord

java.lang.Object
io.goobi.viewer.servlets.oembed.OEmbedRecord
public class OEmbedRecord extends Object
Represents a record available for oEmbed discovery, carrying the endpoint URL and format.

  • Constructor Details

    • OEmbedRecord

      public OEmbedRecord(String uri) throws URISyntaxException

      Constructor for OEmbedRecord.

      Parameters:
      uri - URL string to parse into a URI
      Throws:
      URISyntaxException

    • OEmbedRecord

      public OEmbedRecord()

      Constructor for OEmbedRecord.

  • Method Details

    • getStructElement

      public StructElement getStructElement()
      Getter for the field structElement.
      Returns:
      the top-level structure element of the record to embed

    • setStructElement

      public void setStructElement(StructElement structElement)
      Setter for the field structElement.
      Parameters:
      structElement - the top-level structure element of the record to embed

    • getPhysicalElement

      public PhysicalElement getPhysicalElement()
      Getter for the field physicalElement.
      Returns:
      the physical page element used for the oEmbed response

    • setPhysicalElement

      public void setPhysicalElement(PhysicalElement physicalElement)
      Setter for the field physicalElement.
      Parameters:
      physicalElement - the physical page element to use for the oEmbed response

    • isRichResponse

      public boolean isRichResponse()

      isRichResponse.

      Returns:
      true if this record has a URI set and thus constitutes a rich oEmbed response, false otherwise

    • getUri

      public URI getUri()

      Getter for the field uri.

      Returns:
      the URI of the resource to embed

    • setUri

      public void setUri(URI uri)

      Setter for the field uri.

      Parameters:
      uri - the URI of the resource to embed