thredds.catalog2

Interface Service

public interface Service

Represents a data access service and allows basic data access information to be factored out of dataset Access objects.

Since:

4.0

Author:

edavis

Method Summary

Methods

Modifier and Type	Method and Description
Service	findServiceByNameGlobally(java.lang.String name)
java.net.URI	getBaseUri() Return the base URI for this Service, may not be null.
java.lang.String	getDescription() Returns a human-readable description of this Service.
java.lang.String	getName() Returns the name of this Service, may not be null.
java.util.List<Property>	getProperties() Return the List of Property objects associated with this Service.
Property	getPropertyByName(java.lang.String name)
Service	getServiceByName(java.lang.String name)
java.util.List<Service>	getServices() Return the List of Service Objects nested in this service.
java.lang.String	getSuffix() Return the suffix for this Service.
ServiceType	getType() Return the ServiceType for this Service, may not be null.

Method Detail

getName

java.lang.String getName()

Returns the name of this Service, may not be null.

Returns:

the name of this Service, never null.

getDescription

java.lang.String getDescription()

Returns a human-readable description of this Service.

Returns:

a human-readable description of this service.

getType

ServiceType getType()

Return the ServiceType for this Service, may not be null.

Returns:

the ServiceType for this Service, never null.

getBaseUri

java.net.URI getBaseUri()

Return the base URI for this Service, may not be null.

Returns:

the base URI for this Service, never null.

getSuffix

java.lang.String getSuffix()

Return the suffix for this Service. The suffix will not be null but may be an empty string.

Returns:

the suffix for this Service.

getProperties

java.util.List<Property> getProperties()

Return the List of Property objects associated with this Service.

Returns:

the List of Property objects associated with this Service, may be an empty list but not null.

getPropertyByName

Property getPropertyByName(java.lang.String name)

getServices

java.util.List<Service> getServices()

Return the List of Service Objects nested in this service. Nested services are only allowed when this service has a "Compound" ServiceType.

Returns:

the List of Service Objects nested in this service, may be an empty list but not null.

getServiceByName

Service getServiceByName(java.lang.String name)

findServiceByNameGlobally

Service findServiceByNameGlobally(java.lang.String name)