Package org.ivoa.dm.registry.slap

Class SimpleLineAccess

java.lang.Object
org.ivoa.dm.registry.voresource.Capability
org.ivoa.dm.registry.slap.SimpleLineAccess
All Implemented Interfaces:
org.ivoa.vodml.jpa.JPAManipulations, org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
@Entity @VoDml(id="SLAP:SimpleLineAccess", role=objectType) public class SimpleLineAccess extends Capability implements org.ivoa.vodml.jpa.JPAManipulationsForObjectType<Long>
The capabilities of an SLAP service implementation. objectType: SimpleLineAccess

  • Field Details

    • complianceLevel

      @VoDml(id="SLAP:SimpleLineAccess.complianceLevel", role=attribute, type="SLAP:ComplianceLevel", typeRole=enumeration) protected ComplianceLevel complianceLevel
      The category indicating the level to which this service instance complies with the SLAP standard. Allowed values are 'minimal' and 'full'. See definitions of allowed values for details. : Attribute complianceLevel : multiplicity 1

    • dataSource

      @VoDml(id="SLAP:SimpleLineAccess.dataSource", role=attribute, type="SLAP:DataSource", typeRole=enumeration) protected DataSource dataSource
      The category specifying where the data accessed by the service originally came from. Allowed values are 'observational/astrophysical', 'observational/laboratory', 'theoretical'. : Attribute dataSource : multiplicity 1

    • maxRecords

      @VoDml(id="SLAP:SimpleLineAccess.maxRecords", role=attribute, type="ivoa:integer", typeRole=primitiveType) protected Integer maxRecords
      The hard limit on the largest number of records that the query operation will return in a single response. Not providing this value means that there is no effective limit. This does not refer to the total number of spectra in the archive but rather maximum number of records the service is capable of returning. A limit that is greater than the number of spectra available in the archive is equivalent to their being no effective limit. (See RM, Hanisch 2007.). : Attribute maxRecords : multiplicity 0..1

    • testQuery

      @VoDml(id="SLAP:SimpleLineAccess.testQuery", role=composition, type="SLAP:Query", typeRole=objectType) protected Query testQuery
      A set of queryData parameters that is expected to produce at least one matched record which can be used to test the service. The value should include all parameters required for the test query but should exclude the baseURL and the REQUEST parameter. composition testQuery : ( Multiplicity : 0..1 )

  • Constructor Details

    • SimpleLineAccess

      public SimpleLineAccess()
      Creates a new SimpleLineAccess

    • SimpleLineAccess

      public SimpleLineAccess(ComplianceLevel complianceLevel, DataSource dataSource, Integer maxRecords, Query testQuery, List<Validation> validationLevel, String description, List<Interface> interface_, String standardID)
      full parameter constructor.
      Parameters:
      complianceLevel - The category indicating the level to which this service instance complies with the SLAP standard. Allowed values are 'minimal' and 'full'. See definitions of allowed values for details.
      dataSource - The category specifying where the data accessed by the service originally came from. Allowed values are 'observational/astrophysical', 'observational/laboratory', 'theoretical'.
      maxRecords - The hard limit on the largest number of records that the query operation will return in a single response. Not providing this value means that there is no effective limit. This does not refer to the total number of spectra in the archive but rather maximum number of records the service is capable of returning. A limit that is greater than the number of spectra available in the archive is equivalent to their being no effective limit. (See RM, Hanisch 2007.).
      testQuery - A set of queryData parameters that is expected to produce at least one matched record which can be used to test the service. The value should include all parameters required for the test query but should exclude the baseURL and the REQUEST parameter.
      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.

    • SimpleLineAccess

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

    • SimpleLineAccess

      public SimpleLineAccess(Capability superinstance, ComplianceLevel complianceLevel, DataSource dataSource, Integer maxRecords, Query testQuery)
      Constructor from supertype instance.
      Parameters:
      superinstance - The supertype.
      complianceLevel - The category indicating the level to which this service instance complies with the SLAP standard. Allowed values are 'minimal' and 'full'. See definitions of allowed values for details.
      dataSource - The category specifying where the data accessed by the service originally came from. Allowed values are 'observational/astrophysical', 'observational/laboratory', 'theoretical'.
      maxRecords - The hard limit on the largest number of records that the query operation will return in a single response. Not providing this value means that there is no effective limit. This does not refer to the total number of spectra in the archive but rather maximum number of records the service is capable of returning. A limit that is greater than the number of spectra available in the archive is equivalent to their being no effective limit. (See RM, Hanisch 2007.).
      testQuery - A set of queryData parameters that is expected to produce at least one matched record which can be used to test the service. The value should include all parameters required for the test query but should exclude the baseURL and the REQUEST parameter.

  • Method Details

    • copyMe

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

    • updateUsing

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

    • getComplianceLevel

      public ComplianceLevel getComplianceLevel()
      Returns complianceLevel Attribute.
      Returns:
      complianceLevel Attribute

    • setComplianceLevel

      public void setComplianceLevel(ComplianceLevel pComplianceLevel)
      Set complianceLevel Attribute.
      Parameters:
      pComplianceLevel - value to set

    • withComplianceLevel

      public SimpleLineAccess withComplianceLevel(ComplianceLevel pComplianceLevel)
      fluent setter for complianceLevel Attribute.
      Parameters:
      pComplianceLevel - value to set
      Returns:
      SimpleLineAccess

    • getDataSource

      public DataSource getDataSource()
      Returns dataSource Attribute.
      Returns:
      dataSource Attribute

    • setDataSource

      public void setDataSource(DataSource pDataSource)
      Set dataSource Attribute.
      Parameters:
      pDataSource - value to set

    • withDataSource

      public SimpleLineAccess withDataSource(DataSource pDataSource)
      fluent setter for dataSource Attribute.
      Parameters:
      pDataSource - value to set
      Returns:
      SimpleLineAccess

    • getMaxRecords

      public Integer getMaxRecords()
      Returns maxRecords Attribute.
      Returns:
      maxRecords Attribute

    • setMaxRecords

      public void setMaxRecords(Integer pMaxRecords)
      Set maxRecords Attribute.
      Parameters:
      pMaxRecords - value to set

    • withMaxRecords

      public SimpleLineAccess withMaxRecords(Integer pMaxRecords)
      fluent setter for maxRecords Attribute.
      Parameters:
      pMaxRecords - value to set
      Returns:
      SimpleLineAccess

    • getTestQuery

      public Query getTestQuery()
      Returns testQuery Attribute.
      Returns:
      testQuery Attribute

    • setTestQuery

      public void setTestQuery(Query pTestQuery)
      Set testQuery Attribute.
      Parameters:
      pTestQuery - value to set

    • withTestQuery

      public SimpleLineAccess withTestQuery(Query pTestQuery)
      fluent setter for testQuery Attribute.
      Parameters:
      pTestQuery - value to set
      Returns:
      SimpleLineAccess

    • createSimpleLineAccess

      public static SimpleLineAccess createSimpleLineAccess(Consumer<SimpleLineAccess.SimpleLineAccessBuilder> f)
      create a SimpleLineAccess 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 Capability

    • delete

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