|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RIG
A Resource Invocation Graph (RIG
) is for invocation of a SSWAP
semantic web service. An RIG
is sent by a client to a SSWAP
Resource to invoke the service as described by its Resource Description Graph
(RDG
). Clients (agents invoking a service) make an
RIG
by augmenting the RDG
of a service with the
client's actual invocation values--i.e., the "data"--by adding or
editing the SSWAPSubject
s. Providers (agents delivering a
service) accept RIG
s and change them (according to the contract
of their RDG
into a Resource Response Graph (RRG
).
For more on the protocol, see SSWAP Protocol.
PDG
,
RDG
,
RRG
,
RQG
,
SSWAPResource
,
SSWAPSubject
Method Summary | ||
---|---|---|
RRG |
getRRG()
Gets the RRG that can be used to create a response to the RIG. |
|
RRG |
getRRG(java.io.InputStream is)
Creates an RRG based on the serialized RRG data (e.g., sent by a provider of the service in response to this RIG having been sent to the provider). |
|
SSWAPResource |
getTranslatedResource()
Returns a read-only copy of the SSWAPResource with
properties and types of this RIG translated into the
vocabulary of the RDG . |
|
java.util.Collection<SSWAPSubject> |
getTranslatedSubjects()
Returns a read-only copy of the SSWAPSubject from all
matching SSWAPGraphs with properties and types of this
RIG translated into the vocabulary of the RDG . |
|
HTTPProvider.RRGResponse |
invoke()
Invokes the service with this RIG, blocks until the service responds, and reads back the RRG. |
|
HTTPProvider.RRGResponse |
invoke(long timeout)
Invokes the service with this RIG, blocks until the service responds, and reads back the RRG |
|
|
translate(T node)
Translates a SSWAPNode in this RIG to the vocabulary used by the RDG (the translation only makes sense for SSWAPResources and SSWAPSubjects; for all others the nodes are returned unmodified). |
Methods inherited from interface info.sswap.api.model.SSWAPProtocol |
---|
createGraph, createObject, createObject, createSubject, createSubject, getMappings, getProvider, getResource, isMultiGraphs, isPattern |
Methods inherited from interface info.sswap.api.model.SSWAPDocument |
---|
createAnonymousDatatype, createAnonymousType, createIndividual, createIndividual, createIntersectionOf, createList, createLiteral, createTypedLiteral, createUnionOf, getDatatype, getPredicate, getType, newIndividual, newIndividual |
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 |
---|
<T extends SSWAPNode> T translate(T node)
node
- the node that must belong to this RIG
RRG getRRG() throws DataAccessException, ValidationException
DataAccessException
- if an error should occur while accessing the data in the RIG
to create the RRG
ValidationException
- if the RRG is not valid with respect to the RIG invoking the
serviceRRG getRRG(java.io.InputStream is) throws DataAccessException, ValidationException
is
- the input stream from which the serialized RRG data can be read
DataAccessException
- if an error should occur while reading the data (either an I/O error or problem parsing the data)
ValidationException
- if the RRG is not valid with respect to the RIG for invoking serviceHTTPProvider.RRGResponse invoke()
HTTPProvider.RRGResponse invoke(long timeout)
timeout
- connect and read timeout in milliseconds; if communication with the service should stall for more than the specified time
the call will be interrupted and the returned RRGResponse will contain the error code.
SSWAPResource getTranslatedResource()
SSWAPResource
with
properties and types of this RIG
translated into the
vocabulary of the RDG
.
The translated resource contains only properties that are described in
the RDG
(this includes using the name of a super-property,
if the RIG
used a subproperty with respect to the
RDG
), and types defined in the RDG
.
Given the translated copy returned by the method, use ExtensionAPI.getUntranslatedNode(SSWAPNode)
to retrieve this source individual.
ExtensionAPI.getUntranslatedNode(SSWAPNode)
java.util.Collection<SSWAPSubject> getTranslatedSubjects()
SSWAPSubject
from all
matching SSWAPGraphs
with properties and types of this
RIG
translated into the vocabulary of the RDG
.
The translated subjects contain only properties that are described in the
RDG
(this includes using the name of a super-property, if
the RIG
used a subproperty with respect to the
RDG
), and types defined in the RDG
.
The special case of SSWAPSubject.addObject(SSWAPObject)
and its
set()
variants are not read-only and changes the underlying
SSWAPSubject
.
Given the translated copy returned by the method, use ExtensionAPI.getUntranslatedNode(SSWAPNode)
to retrieve this source individual.
ExtensionAPI.getUntranslatedNode(SSWAPNode)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |