Package eu.clarin.sru.client.fcs

Class ClarinFCSEndpointDescription.ResourceInfo

java.lang.Object

eu.clarin.sru.client.fcs.ClarinFCSEndpointDescription.ResourceInfo

All Implemented Interfaces:

Serializable

Enclosing class:

ClarinFCSEndpointDescription

public static final class ClarinFCSEndpointDescription.ResourceInfo
extends Object
implements Serializable

This class implements a description of a resource available at an endpoint.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClarinFCSEndpointDescription.ResourceInfo.AvailabilityRestriction	Enumeration to indicate the content encoding of a layer.

Method Summary

Modifier and Type	Method	Description
ClarinFCSEndpointDescription.ResourceInfo.AvailabilityRestriction	getAvailabilityRestriction()	Get the availabiliy restriction for this resource.
List<ClarinFCSEndpointDescription.DataView>	getAvailableDataViews()	Get the list of data views that are available for this resource.
List<ClarinFCSEndpointDescription.Layer>	getAvailableLayers()	(ADV-FCS) Get the list of layers that are available for this resource.
Map<String,String>	getDescription()	Get the description of this resource.
String	getDescription(String language)	Get the description of the resource for a specific language code.
Map<String,String>	getInstitution()	Get the institution of this resource.
String	getInstitution(String language)	Get the institution of this resource for a specific language code.
String	getLandingPageURI()	Get the landing page of this resource.
List<String>	getLanguages()	Get the list of languages in this resource represented as ISO-632-3 three letter language code.
String	getPid()	Get the persistent identifier of this resource.
List<ClarinFCSEndpointDescription.ResourceInfo>	getSubResources()	Get the direct sub-ordinate resources of this resource.
Map<String,String>	getTitle()	Get the title of this resource.
String	getTitle(String language)	Get the title of the resource for a specific language code.
boolean	hasAvailabilityRestriction()	Check, if this resource has any kind of availability restriction.
boolean	hasSubResources()	Determine, if this resource has sub-resources.
boolean	supportsLanguage(String language)	Check, if this resource supports a certain language.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getPid

public String getPid()

Get the persistent identifier of this resource.

Returns:

a string representing the persistent identifier of this resource

hasSubResources

public boolean hasSubResources()

Determine, if this resource has sub-resources.

Returns:

true if the resource has sub-resources, false otherwise

getTitle

public Map<String,String> getTitle()

Get the title of this resource.

Returns:

a Map of titles keyed by language code

getTitle

public String getTitle(String language)

Get the title of the resource for a specific language code.

Parameters:

language - the language code

Returns:

the title for the language code or null if no title for this language code exists

getDescription

public Map<String,String> getDescription()

Get the description of this resource.

Returns:

a Map of descriptions keyed by language code

getDescription

public String getDescription(String language)

Get the description of the resource for a specific language code.

Parameters:

language - the language code

Returns:

the description for the language code or null if no title for this language code exists

getInstitution

public Map<String,String> getInstitution()

Get the institution of this resource. This is an optional attribute for endpoints that host resources from different institution but still want to bundle them in one endpoint. If not specified then it is the default institution that hosts the FCS endpoint.

Returns:

the institution of this resource or null if not applicable or specified

getInstitution

public String getInstitution(String language)

Get the institution of this resource for a specific language code.

Parameters:

language - the language code

Returns:

the institution of this resource or null if not applicable or specified

getLandingPageURI

public String getLandingPageURI()

Get the landing page of this resource.

Returns:

the landing page of this resource or null if not applicable

getLanguages

public List<String> getLanguages()

Get the list of languages in this resource represented as ISO-632-3 three letter language code.

Returns:

the list of languages in this resource as a list of ISO-632-3 three letter language codes.

supportsLanguage

public boolean supportsLanguage(String language)

Check, if this resource supports a certain language.

Parameters:

language - a language encoded as a ISO-632-3 three letter language code

Returns:

true if the language is supported by this resource, false otherwise

hasAvailabilityRestriction

public boolean hasAvailabilityRestriction()

Check, if this resource has any kind of availability restriction.

Returns:

true if resource declares an availability restriction of any kind.

getAvailabilityRestriction

public ClarinFCSEndpointDescription.ResourceInfo.AvailabilityRestriction getAvailabilityRestriction()

Get the availabiliy restriction for this resource.

Returns:

the availability restriction, or null if none.

getSubResources

public List<ClarinFCSEndpointDescription.ResourceInfo> getSubResources()

Get the direct sub-ordinate resources of this resource.

Returns:

a list of resources or null if this resource has no sub-ordinate resources

getAvailableDataViews

public List<ClarinFCSEndpointDescription.DataView> getAvailableDataViews()

Get the list of data views that are available for this resource.

Returns:

the list of data views available for this resource

getAvailableLayers

public List<ClarinFCSEndpointDescription.Layer> getAvailableLayers()

(ADV-FCS) Get the list of layers that are available for this resource.

Returns:

the list of layers views available for this resource