Package org.ivoa.dm.registry.tap

Class OutputFormat

java.lang.Object
org.ivoa.dm.registry.tap.OutputFormat
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="TAPRegExt:OutputFormat", role=objectType) public class OutputFormat extends Object implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
An output format supported by the service. All TAP services must support VOTable output, preserving the MIME type of the input. Other output formats are optional. The primary identifier for an output format is the MIME type. If you want to register an output format, you must use a MIME type (or make one up using the x- syntax), although the concrete MIME syntax is not enforced by the schema. For more detailed specification, an IVORN may be used. objectType: OutputFormat

  • Field Details

    • _id

      protected Long _id
      inserted database key

    • mime

      @VoDml(id="TAPRegExt:OutputFormat.mime", role=attribute, type="ivoa:string", typeRole=primitiveType) protected String mime
      The MIME type of this format. The format of this string is specified by RFC 2045. The service has to accept this string as a value of the FORMAT parameter. : Attribute mime : multiplicity 1

    • alias

      @VoDml(id="TAPRegExt:OutputFormat.alias", role=attribute, type="ivoa:string", typeRole=primitiveType) protected List<String> alias
      Other values of FORMAT ('shorthands') that make the service return documents with the MIME type. : Attribute alias : multiplicity 0..*

    • ivoid

      @VoDml(id="TAPRegExt:OutputFormat.ivoid", role=attribute, type="ivoa:anyURI", typeRole=primitiveType) protected String ivoid
      An optional IVORN of the output format. When the MIME type does not uniquely define the format (or a generic MIME like application/octet-stream or text/plain is given), the IVORN can point to a key or StandardsRegExt document defining the format more precisely. To see values defined in TAPRegExt, retrieve the ivo://ivoa.net/std/TAPRegExt resource record and look for keys starting with 'output-'. : Attribute ivoid : multiplicity 1

  • Constructor Details

    • OutputFormat

      public OutputFormat()
      Creates a new OutputFormat

    • OutputFormat

      public OutputFormat(String mime, List<String> alias, String ivoid)
      full parameter constructor.
      Parameters:
      mime - The MIME type of this format. The format of this string is specified by RFC 2045. The service has to accept this string as a value of the FORMAT parameter.
      alias - Other values of FORMAT ('shorthands') that make the service return documents with the MIME type.
      ivoid - An optional IVORN of the output format. When the MIME type does not uniquely define the format (or a generic MIME like application/octet-stream or text/plain is given), the IVORN can point to a key or StandardsRegExt document defining the format more precisely. To see values defined in TAPRegExt, retrieve the ivo://ivoa.net/std/TAPRegExt resource record and look for keys starting with 'output-'.

    • OutputFormat

      public OutputFormat(OutputFormat other)
      Copy Constructor. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

  • Method Details

    • getId

      public Long getId()
      Specified by:
      getId in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
      Returns:
      the id

    • updateUsing

      public void updateUsing(OutputFormat other)
      Update this object with the content of the given object. Note that references will remain as is rather than be copied.
      Parameters:
      other - the object to be copied.

    • getMime

      public String getMime()
      Returns mime Attribute.
      Returns:
      mime Attribute

    • setMime

      public void setMime(String pMime)
      Set mime Attribute.
      Parameters:
      pMime - value to set

    • withMime

      public OutputFormat withMime(String pMime)
      fluent setter for mime Attribute.
      Parameters:
      pMime - value to set
      Returns:
      OutputFormat

    • getAlias

      public List<String> getAlias()
      Returns alias Attribute.
      Returns:
      alias Attribute

    • setAlias

      public void setAlias(List<String> pAlias)
      Set alias Attribute.
      Parameters:
      pAlias - value to set

    • withAlias

      public OutputFormat withAlias(List<String> pAlias)
      fluent setter for alias Attribute.
      Parameters:
      pAlias - value to set
      Returns:
      OutputFormat

    • getIvoid

      public String getIvoid()
      Returns ivoid Attribute.
      Returns:
      ivoid Attribute

    • setIvoid

      public void setIvoid(String pIvoid)
      Set ivoid Attribute.
      Parameters:
      pIvoid - value to set

    • withIvoid

      public OutputFormat withIvoid(String pIvoid)
      fluent setter for ivoid Attribute.
      Parameters:
      pIvoid - value to set
      Returns:
      OutputFormat

    • createOutputFormat

      public static OutputFormat createOutputFormat(Consumer<OutputFormat.OutputFormatBuilder> f)
      create a OutputFormat in functional builder style.
      Parameters:
      f - the functional builder.
      Returns:
      an object initialized from the builder.

    • forceLoad

      public void forceLoad()
      Specified by:
      forceLoad in interface org.ivoa.vodml.jpa.JPAManipulations

    • delete

      public void delete(jakarta.persistence.EntityManager em)
      Specified by:
      delete in interface org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>