Package org.ivoa.dm.registry.tap

Class TableAccess

java.lang.Object
org.ivoa.dm.registry.voresource.Capability
org.ivoa.dm.registry.tap.TAPCapRestriction
org.ivoa.dm.registry.tap.TableAccess
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="TAPRegExt:TableAccess", role=objectType) public class TableAccess extends TAPCapRestriction implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
The capabilities of a TAP server. The capabilities attempt to define most issues that the TAP standard leaves to the implementors ('may', 'should'). objectType: TableAccess

  • Field Details

    • dataModel

      @VoDml(id="TAPRegExt:TableAccess.dataModel", role=attribute, type="TAPRegExt:DataModelType", typeRole=dataType) protected List<DataModelType> dataModel
      Identifier of IVOA-approved data model supported by the service. : Attribute dataModel : multiplicity 0..*

    • language

      @VoDml(id="TAPRegExt:TableAccess.language", role=composition, type="TAPRegExt:Language", typeRole=objectType) protected List<Language> language
      Language supported by the service. composition language : ( Multiplicity : 1..* )

    • outputFormat

      @VoDml(id="TAPRegExt:TableAccess.outputFormat", role=composition, type="TAPRegExt:OutputFormat", typeRole=objectType) protected List<OutputFormat> outputFormat
      Output format supported by the service. composition outputFormat : ( Multiplicity : 1..* )

    • uploadMethod

      @VoDml(id="TAPRegExt:TableAccess.uploadMethod", role=composition, type="TAPRegExt:UploadMethod", typeRole=objectType) protected List<UploadMethod> uploadMethod
      Upload method supported by the service. The absence of upload methods indicates that the service does not support uploads at all. composition uploadMethod : ( Multiplicity : 0..* )

    • retentionPeriod

      @VoDml(id="TAPRegExt:TableAccess.retentionPeriod", role=composition, type="TAPRegExt:TimeLimits", typeRole=objectType) protected TimeLimits retentionPeriod
      Limits on the time between job creation and destruction time. composition retentionPeriod : ( Multiplicity : 0..1 )

    • executionDuration

      @VoDml(id="TAPRegExt:TableAccess.executionDuration", role=composition, type="TAPRegExt:TimeLimits", typeRole=objectType) protected TimeLimits executionDuration
      Limits on executionDuration. composition executionDuration : ( Multiplicity : 0..1 )

    • outputLimit

      @VoDml(id="TAPRegExt:TableAccess.outputLimit", role=composition, type="TAPRegExt:DataLimits", typeRole=objectType) protected DataLimits outputLimit
      Limits on the size of data returned. composition outputLimit : ( Multiplicity : 0..1 )

    • uploadLimit

      @VoDml(id="TAPRegExt:TableAccess.uploadLimit", role=composition, type="TAPRegExt:DataLimits", typeRole=objectType) protected DataLimits uploadLimit
      Limits on the size of uploaded data. composition uploadLimit : ( Multiplicity : 0..1 )

  • Constructor Details

    • TableAccess

      public TableAccess()
      Creates a new TableAccess

    • TableAccess

      public TableAccess(List<DataModelType> dataModel, List<Language> language, List<OutputFormat> outputFormat, List<UploadMethod> uploadMethod, TimeLimits retentionPeriod, TimeLimits executionDuration, DataLimits outputLimit, DataLimits uploadLimit, List<Validation> validationLevel, String description, List<Interface> interface_, String standardID)
      full parameter constructor.
      Parameters:
      dataModel - Identifier of IVOA-approved data model supported by the service.
      language - Language supported by the service.
      outputFormat - Output format supported by the service.
      uploadMethod - Upload method supported by the service. The absence of upload methods indicates that the service does not support uploads at all.
      retentionPeriod - Limits on the time between job creation and destruction time.
      executionDuration - Limits on executionDuration.
      outputLimit - Limits on the size of data returned.
      uploadLimit - Limits on the size of uploaded data.
      validationLevel - A numeric grade describing the quality of the capability description and interface, when applicable, to be used to indicate the confidence an end-user can put in the resource as part of a VO application or research study. See VOResource:ValidationLevel for an explanation of the allowed levels.
      description - A human-readable description of what this capability provides as part of the over-all service Use of this optional element is especially encouraged when this capability is non-standard and is one of several capabilities listed.
      interface_ - a description of how to call the service to access this capability Since the Interface type is abstract, one must describe the interface using a subclass of Interface, denoting it via xsi:type. Multiple occurences can describe different interfaces to the logically same capability, i.e. data or functionality. That is, the inputs accepted and the output provides should be logically the same. For example, a WebBrowser interface given in addition to a WebService interface would simply provide an interactive, human-targeted interface to the underlying WebService interface.
      standardID - A URI identifier for a standard service. This provides a unique way to refer to a service specification standard, such as a Simple Image Access service. The use of an IVOA identifier here implies that a VOResource description of the standard is registered and accessible.

    • TableAccess

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

    • TableAccess

      public TableAccess(TAPCapRestriction superinstance, List<DataModelType> dataModel, List<Language> language, List<OutputFormat> outputFormat, List<UploadMethod> uploadMethod, TimeLimits retentionPeriod, TimeLimits executionDuration, DataLimits outputLimit, DataLimits uploadLimit)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      dataModel - Identifier of IVOA-approved data model supported by the service.
      language - Language supported by the service.
      outputFormat - Output format supported by the service.
      uploadMethod - Upload method supported by the service. The absence of upload methods indicates that the service does not support uploads at all.
      retentionPeriod - Limits on the time between job creation and destruction time.
      executionDuration - Limits on executionDuration.
      outputLimit - Limits on the size of data returned.
      uploadLimit - Limits on the size of uploaded data.

  • Method Details

    • copyMe

      public Capability copyMe()
      make a clone of the object taking into account current polymorhic type.
      Specified by:
      copyMe in class TAPCapRestriction
      Returns:
      the cloned object.

    • updateUsing

      public void updateUsing(TableAccess 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.

    • getDataModel

      public List<DataModelType> getDataModel()
      Returns dataModel Attribute.
      Returns:
      dataModel Attribute

    • setDataModel

      public void setDataModel(List<DataModelType> pDataModel)
      Set dataModel Attribute.
      Parameters:
      pDataModel - value to set

    • withDataModel

      public TableAccess withDataModel(List<DataModelType> pDataModel)
      fluent setter for dataModel Attribute.
      Parameters:
      pDataModel - value to set
      Returns:
      TableAccess

    • getLanguage

      public List<Language> getLanguage()
      Returns language composition as an immutable list.
      Returns:
      language composition.

    • setLanguage

      public void setLanguage(List<Language> pLanguage)
      Defines whole language composition.
      Parameters:
      pLanguage - composition to set.

    • addToLanguage

      public void addToLanguage(Language p)
      Add a org.ivoa.dm.registry.tap.Language to the composition.
      Parameters:
      p - org.ivoa.dm.registry.tap.Language to add

    • removeFromLanguage

      public void removeFromLanguage(Language p)
      Remove a org.ivoa.dm.registry.tap.Language from the composition.
      Parameters:
      p - org.ivoa.dm.registry.tap.Language to remove

    • replaceInLanguage

      public void replaceInLanguage(Language _p)
      update a org.ivoa.dm.registry.tap.Language in the composition.
      Parameters:
      _p - org.ivoa.dm.registry.tap.Language to update the match is done via the database key

    • getOutputFormat

      public List<OutputFormat> getOutputFormat()
      Returns outputFormat composition as an immutable list.
      Returns:
      outputFormat composition.

    • setOutputFormat

      public void setOutputFormat(List<OutputFormat> pOutputFormat)
      Defines whole outputFormat composition.
      Parameters:
      pOutputFormat - composition to set.

    • addToOutputFormat

      public void addToOutputFormat(OutputFormat p)
      Add a org.ivoa.dm.registry.tap.OutputFormat to the composition.
      Parameters:
      p - org.ivoa.dm.registry.tap.OutputFormat to add

    • removeFromOutputFormat

      public void removeFromOutputFormat(OutputFormat p)
      Remove a org.ivoa.dm.registry.tap.OutputFormat from the composition.
      Parameters:
      p - org.ivoa.dm.registry.tap.OutputFormat to remove

    • replaceInOutputFormat

      public void replaceInOutputFormat(OutputFormat _p)
      update a org.ivoa.dm.registry.tap.OutputFormat in the composition.
      Parameters:
      _p - org.ivoa.dm.registry.tap.OutputFormat to update the match is done via the database key

    • getUploadMethod

      public List<UploadMethod> getUploadMethod()
      Returns uploadMethod composition as an immutable list.
      Returns:
      uploadMethod composition.

    • setUploadMethod

      public void setUploadMethod(List<UploadMethod> pUploadMethod)
      Defines whole uploadMethod composition.
      Parameters:
      pUploadMethod - composition to set.

    • addToUploadMethod

      public void addToUploadMethod(UploadMethod p)
      Add a org.ivoa.dm.registry.tap.UploadMethod to the composition.
      Parameters:
      p - org.ivoa.dm.registry.tap.UploadMethod to add

    • removeFromUploadMethod

      public void removeFromUploadMethod(UploadMethod p)
      Remove a org.ivoa.dm.registry.tap.UploadMethod from the composition.
      Parameters:
      p - org.ivoa.dm.registry.tap.UploadMethod to remove

    • replaceInUploadMethod

      public void replaceInUploadMethod(UploadMethod _p)
      update a org.ivoa.dm.registry.tap.UploadMethod in the composition.
      Parameters:
      _p - org.ivoa.dm.registry.tap.UploadMethod to update the match is done via the database key

    • getRetentionPeriod

      public TimeLimits getRetentionPeriod()
      Returns retentionPeriod Attribute.
      Returns:
      retentionPeriod Attribute

    • setRetentionPeriod

      public void setRetentionPeriod(TimeLimits pRetentionPeriod)
      Set retentionPeriod Attribute.
      Parameters:
      pRetentionPeriod - value to set

    • withRetentionPeriod

      public TableAccess withRetentionPeriod(TimeLimits pRetentionPeriod)
      fluent setter for retentionPeriod Attribute.
      Parameters:
      pRetentionPeriod - value to set
      Returns:
      TableAccess

    • getExecutionDuration

      public TimeLimits getExecutionDuration()
      Returns executionDuration Attribute.
      Returns:
      executionDuration Attribute

    • setExecutionDuration

      public void setExecutionDuration(TimeLimits pExecutionDuration)
      Set executionDuration Attribute.
      Parameters:
      pExecutionDuration - value to set

    • withExecutionDuration

      public TableAccess withExecutionDuration(TimeLimits pExecutionDuration)
      fluent setter for executionDuration Attribute.
      Parameters:
      pExecutionDuration - value to set
      Returns:
      TableAccess

    • getOutputLimit

      public DataLimits getOutputLimit()
      Returns outputLimit Attribute.
      Returns:
      outputLimit Attribute

    • setOutputLimit

      public void setOutputLimit(DataLimits pOutputLimit)
      Set outputLimit Attribute.
      Parameters:
      pOutputLimit - value to set

    • withOutputLimit

      public TableAccess withOutputLimit(DataLimits pOutputLimit)
      fluent setter for outputLimit Attribute.
      Parameters:
      pOutputLimit - value to set
      Returns:
      TableAccess

    • getUploadLimit

      public DataLimits getUploadLimit()
      Returns uploadLimit Attribute.
      Returns:
      uploadLimit Attribute

    • setUploadLimit

      public void setUploadLimit(DataLimits pUploadLimit)
      Set uploadLimit Attribute.
      Parameters:
      pUploadLimit - value to set

    • withUploadLimit

      public TableAccess withUploadLimit(DataLimits pUploadLimit)
      fluent setter for uploadLimit Attribute.
      Parameters:
      pUploadLimit - value to set
      Returns:
      TableAccess

    • createTableAccess

      public static TableAccess createTableAccess(Consumer<TableAccess.TableAccessBuilder> f)
      create a TableAccess 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
      Overrides:
      forceLoad in class TAPCapRestriction

    • delete

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