info.sswap.api.model
Interface SSWAPProvider

All Superinterfaces:
SSWAPElement, SSWAPIndividual, SSWAPModel, SSWAPNode
All Known Implementing Classes:
ProviderImpl

public interface SSWAPProvider
extends SSWAPNode

Describes a provider in SSWAP. The data about providers is available in a PDG. Usually, a service provider such as an institution or a web site will host a single provider URI and multiple services, each service represented by its own RDG.

Author:
Blazej Bulka
See Also:
PDG

Method Summary
 void addProvidesResource(SSWAPResource resource)
          Adds a resource that is provided by this provider to the list.
 java.net.URI getAboutURI()
          Gets the URI pointing to a human-readable description of this provider.
 java.net.URI getMetadata()
          Gets the URI containing the machine-readable metadata for this provider.
 java.lang.String getName()
          Gets the name of the provider.
 java.lang.String getOneLineDescription()
          Gets one line description of the provider.
 PDG getPDG()
          Gets the PDG that defines this provider
 java.util.Collection<SSWAPResource> getProvidesResources()
          Gets the information about all the resources provided by this provider.
 void setAboutURI(java.net.URI aboutURI)
          Sets the URI pointing to a human-readable description of this provider.
 void setMetadata(java.net.URI metadata)
          Sets the URI pointing to the machine-readable metadata for this provider.
 void setName(java.lang.String name)
          Sets the name of the provider.
 void setOneLineDescription(java.lang.String oneLineDescription)
          Sets one line description of the provider.
 void setProvidesResource(java.util.Collection<SSWAPResource> resources)
          Sets the information about all the resources provided by this provider.
 
Methods inherited from interface info.sswap.api.model.SSWAPNode
asSSWAPGraph, asSSWAPObject, asSSWAPProvider, asSSWAPResource, asSSWAPSubject, getID, isSSWAPGraph, isSSWAPObject, isSSWAPProvider, isSSWAPResource, isSSWAPSubject
 
Methods inherited from interface info.sswap.api.model.SSWAPIndividual
addProperty, addProperty, addProperty, addProperty, addType, clearProperty, getDeclaredType, getDeclaredTypes, getInferredIndividual, getProperties, getProperties, getProperty, getType, getTypes, hasValue, hasValue, isAnonymous, isCompatibleWith, isOfType, removeProperty, removeProperty, removeType, setProperty, setProperty, setProperty, setProperty
 
Methods inherited from interface info.sswap.api.model.SSWAPElement
addComment, addLabel, asBoolean, asDouble, asIndividual, asInteger, asList, asLiteral, asString, getComment, getLabel, isIndividual, isList, isLiteral
 
Methods inherited from interface info.sswap.api.model.SSWAPModel
addImport, checkProfile, dereference, dereference, doClosure, getDocument, getImports, getInputStream, getNsPrefixMap, getReasoningService, getTypeSignature, getURI, isDereferenced, removeImport, removeNsPrefix, serialize, serialize, setNsPrefix, validate
 

Method Detail

getName

java.lang.String getName()
Gets the name of the provider. A valid description of the provider must include the information about the name. (The invalid graphs that do not provide information about the provider, will cause this method to return null.)

Returns:
name of the provider (or null for invalid graphs)

setName

void setName(java.lang.String name)
Sets the name of the provider. A valid name of the provider must not be null.

Parameters:
name - the name of the provider (must not be null).

getOneLineDescription

java.lang.String getOneLineDescription()
Gets one line description of the provider.

Returns:
one line description of the provider (or null if not available).

setOneLineDescription

void setOneLineDescription(java.lang.String oneLineDescription)
Sets one line description of the provider.

Parameters:
oneLineDescription - the new one line description of the provider, or null if the current description is to be removed.

getAboutURI

java.net.URI getAboutURI()
Gets the URI pointing to a human-readable description of this provider. This URI should be dereferenceable if not null.

Returns:
URI pointing to a human-readable description, or null if there is no such description for the provider.

setAboutURI

void setAboutURI(java.net.URI aboutURI)
Sets the URI pointing to a human-readable description of this provider. This URI should be dereferenceable or null.

Parameters:
aboutURI - URI pointing to a human-readable description of this provider, or null if there is no such description for the provider.

getMetadata

java.net.URI getMetadata()
Gets the URI containing the machine-readable metadata for this provider. This URI should be dereferenceable or null.

Returns:
URI pointing to a machine-readable metadata for this provider, or null if there is no metadata for this provider.

setMetadata

void setMetadata(java.net.URI metadata)
Sets the URI pointing to the machine-readable metadata for this provider. This URI should be dereferenceable or null.

Parameters:
metadata - URI pointing to a machine-readable metadata for this provider, or null if there is no metadata for this provider.

addProvidesResource

void addProvidesResource(SSWAPResource resource)
Adds a resource that is provided by this provider to the list.

Parameters:
resource - a SSWAPResource that is provided by this provider. (The object may not be dereferenced, since the only information stored in a PDG about the provided resource is the resource's URI).

setProvidesResource

void setProvidesResource(java.util.Collection<SSWAPResource> resources)
Sets the information about all the resources provided by this provider.

Parameters:
resources - a set of SSWAPResource that are provided by this provider. (The objects may not be dereferenced, since the only information stored in a PDG about the provided resource is the resource's URI).

getProvidesResources

java.util.Collection<SSWAPResource> getProvidesResources()
Gets the information about all the resources provided by this provider.

Returns:
a collection of SSWAPResource objects, which are not dereferenced (the information about them is stored in different documents).

getPDG

PDG getPDG()
Gets the PDG that defines this provider

Returns:
PDG the PDG to which this Provider belongs


Copyright (c) 2011, iPlant Collaborative, University of Arizona, Cold Spring Harbor Laboratories, University of Texas at Austin.