Package org.javastro.ivoa.entities.resource.tap

Class OutputFormat

java.lang.Object
org.javastro.ivoa.entities.resource.tap.OutputFormat
All Implemented Interfaces:
org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
@Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public class OutputFormat extends Object implements org.jvnet.jaxb.lang.MergeFrom, org.jvnet.jaxb.lang.ToString
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.

Java class for OutputFormat complex type

.

The following schema fragment specifies the expected content contained within this class.


 <complexType name="OutputFormat">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="mime" type="{http://www.w3.org/2001/XMLSchema}token"/>
         <element name="alias" type="{http://www.w3.org/2001/XMLSchema}token" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="ivo-id" type="{http://www.w3.org/2001/XMLSchema}anyURI" />
     </restriction>
   </complexContent>
 </complexType>

  • Field Details

    • mime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected String mime
      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

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected List<String> alias
      Other values of FORMAT ("shorthands") that make the service return documents with the MIME type.

    • ivoId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") protected String ivoId
      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-".

  • Constructor Details

    • OutputFormat

      public OutputFormat()
      Default no-arg constructor

    • OutputFormat

      public OutputFormat(String mime, List<String> alias, String ivoId)
      Fully-initialising value constructor

  • Method Details

    • getMime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String getMime()
      The format of this string is specified by RFC 2045. The service has to accept this string as a value of the FORMAT parameter.
      Returns:
      possible object is String

    • setMime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setMime(String value)
      Sets the value of the mime property.
      Parameters:
      value - allowed object is String
      See Also:

    • getAlias

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public List<String> getAlias()
      Other values of FORMAT ("shorthands") that make the service return documents with the MIME type. Gets the value of the alias property.

      This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the alias property.

      For example, to add a new item, do as follows: 

       getAlias().add(newItem);

      Objects of the following type(s) are allowed in the list String

      Returns:
      The value of the alias property.

    • getIvoId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String getIvoId()
      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-".
      Returns:
      possible object is String

    • setIvoId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void setIvoId(String value)
      Sets the value of the ivoId property.
      Parameters:
      value - allowed object is String
      See Also:

    • equals

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public boolean equals(Object object)
      Overrides:
      equals in class Object

    • hashCode

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public String toString()
      Overrides:
      toString in class Object

    • append

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public StringBuilder append(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
      Specified by:
      append in interface org.jvnet.jaxb.lang.ToString

    • appendFields

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public StringBuilder appendFields(org.jvnet.jaxb.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb.lang.ToStringStrategy strategy)
      Specified by:
      appendFields in interface org.jvnet.jaxb.lang.ToString

    • withMime

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public OutputFormat withMime(String value)

    • withAlias

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public OutputFormat withAlias(String... values)

    • withAlias

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public OutputFormat withAlias(Collection<String> values)

    • withIvoId

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public OutputFormat withIvoId(String value)

    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void mergeFrom(Object left, Object right)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

    • mergeFrom

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public void mergeFrom(org.jvnet.jaxb.locator.ObjectLocator leftLocator, org.jvnet.jaxb.locator.ObjectLocator rightLocator, Object left, Object right, org.jvnet.jaxb.lang.MergeStrategy strategy)
      Specified by:
      mergeFrom in interface org.jvnet.jaxb.lang.MergeFrom

    • createNewInstance

      @Generated(value="com.sun.tools.xjc.Driver", comments="JAXB RI v4.0.4", date="2024-08-01T13:15:43+01:00") public Object createNewInstance()
      Specified by:
      createNewInstance in interface org.jvnet.jaxb.lang.MergeFrom