Package uk.ac.starlink.votable.datalink
Interface ServiceDescriptor
-
public interface ServiceDescriptor
Describes an invocable service as defined by a DataLink Service Descriptor. This is usually read from a VOTable RESOURCE element with @type="meta" and @utype="adhoc:service".- Since:
- 22 Nov 2017
- Author:
- Mark Taylor
- See Also:
- DataLink-1.0, sec 4
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAccessUrl()
Returns the access URL defined by this service.java.lang.String
getDescription()
Returns descriptive text for this service.java.lang.String
getDescriptorId()
Returns the identifier for this service descriptor.ServiceParam[]
getInputParams()
Returns a list of input parameters associated with this service.java.lang.String
getName()
Returns a name for this service.java.lang.String
getResourceIdentifier()
Returns an IVOA registry identifier for this service.java.lang.String
getStandardId()
Returns the capability URI corresponding to this service.
-
-
-
Method Detail
-
getDescriptorId
java.lang.String getDescriptorId()
Returns the identifier for this service descriptor. This corresponds to the ID attribute on the RESOURCE.- Returns:
- descriptor ID, may be null
-
getAccessUrl
java.lang.String getAccessUrl()
Returns the access URL defined by this service. It may be a partial/base URL. This corresponds to the PARAM with @name="accessURL".- Returns:
- access URL; according to DataLink this is required, but this interface does not guarantee a non-null value
-
getStandardId
java.lang.String getStandardId()
Returns the capability URI corresponding to this service. This corresponds to the PARAM with @name="standardID".- Returns:
- standardID, may be null
-
getResourceIdentifier
java.lang.String getResourceIdentifier()
Returns an IVOA registry identifier for this service. This corresponds to the PARAM with @name="resourceIdentifier".- Returns:
- ivoid, may be null
-
getName
java.lang.String getName()
Returns a name for this service. This could for instance be obtained from thename
attribute on the RESOURCE. Provision of this metadata is not discussed by the DataLink standard, but it may be useful to have, especially for service descriptors in "normal" rather than links-response VOTables.- Returns:
- service name, may be null
-
getDescription
java.lang.String getDescription()
Returns descriptive text for this service. This could for instance be extracted from a suitableDESCRIPTION
element. Provision of this metadata is not discussed by the DataLink standard, but it may be useful to have, especially for service descriptors in "normal" rather than links-response VOTables.- Returns:
- textual description of service, may be null
-
getInputParams
ServiceParam[] getInputParams()
Returns a list of input parameters associated with this service. This corresponds to the PARAM descendants of a child GROUP with @name="inputParams".- Returns:
- service input parameter list
-
-