diff --git a/doc/RDFService/allclasses-frame.html b/doc/RDFService/allclasses-frame.html new file mode 100644 index 000000000..6fe4f7f04 --- /dev/null +++ b/doc/RDFService/allclasses-frame.html @@ -0,0 +1,49 @@ + + + +
+ +ChangeListener
+ +ChangeSet + +ModelChange + +ModelChange.Operation + +RDFService + +RDFService.ModelSerializationFormat + +RDFService.ResultFormat + +RDFService.SPARQLQueryType + +RDFServiceException + +RDFServiceFactory + + |
+
ChangeListener
+ +ChangeSet + +ModelChange + +ModelChange.Operation + +RDFService + +RDFService.ModelSerializationFormat + +RDFService.ResultFormat + +RDFService.SPARQLQueryType + +RDFServiceException + +RDFServiceFactory + + |
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
public interface ChangeListener
+An interface for listening to triples that are added to or removed + from the triple store, and other miscellaneous events. +
+ +
+
+Method Summary | +|
---|---|
+ void |
+addedStatement(java.lang.String serializedTriple,
+ java.lang.String graphURI)
+
++ Override this to listen to all statements added to the RDF store. |
+
+ void |
+notifyEvent(java.lang.String graphURI,
+ java.lang.Object event)
+
++ Override this to listen to events pertaining to the given graphURI. |
+
+ void |
+removedStatement(java.lang.String serializedTriple,
+ java.lang.String graphURI)
+
++ Override this to listen to all statements removed from the RDF store. |
+
+Method Detail | +
---|
+void addedStatement(java.lang.String serializedTriple, + java.lang.String graphURI)+
+
serializedTriple
- - the added statement in n3 formatgraphURI
- - the graph to which the statement was added+void removedStatement(java.lang.String serializedTriple, + java.lang.String graphURI)+
+
serializedTriple
- - the removed statement in n3 formatgraphURI
- - the graph from which the statement was removed+void notifyEvent(java.lang.String graphURI, + java.lang.Object event)+
+
graphURI
- - the graph to which the event pertainsevent
- - the event that occurred.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
public interface ChangeSet
+Input parameter to changeSetUpdate() method in RDFService. + Represents a precondition query and an ordered list of model changes. +
+ +
+
+Method Summary | +|
---|---|
+ void |
+addAddition(java.io.InputStream model,
+ RDFService.ModelSerializationFormat serializationFormat,
+ java.lang.String graphURI)
+
++ Adds one model change representing an addition to the list of model changes |
+
+ void |
+addPostChangeEvent(java.lang.Object event)
+
++ Adds an event that will be be passed to any change listeners after all of + the change set additions and retractions are performed. |
+
+ void |
+addPreChangeEvent(java.lang.Object event)
+
++ Adds an event that will be be passed to any change listeners in advance of + the change set additions and retractions being performed. |
+
+ void |
+addRemoval(java.io.InputStream model,
+ RDFService.ModelSerializationFormat serializationFormat,
+ java.lang.String graphURI)
+
++ Adds one model change representing a deletion to the list of model changes |
+
+ java.util.List<ModelChange> |
+getModelChanges()
+
++ |
+
+ java.util.List<java.lang.Object> |
+getPostChangeEvents()
+
++ Returns a list of events to pass to any change listeners after + the change set additions and retractions are performed. |
+
+ java.util.List<java.lang.Object> |
+getPreChangeEvents()
+
++ Returns a list of events to pass to any change listeners in + advance of the change set additions and retractions being performed. |
+
+ java.lang.String |
+getPreconditionQuery()
+
++ |
+
+ RDFService.SPARQLQueryType |
+getPreconditionQueryType()
+
++ |
+
+ ModelChange |
+manufactureModelChange()
+
++ Creates an instance of the ModelChange class |
+
+ ModelChange |
+manufactureModelChange(java.io.InputStream serializedModel,
+ RDFService.ModelSerializationFormat serializationFormat,
+ ModelChange.Operation operation,
+ java.lang.String graphURI)
+
++ Creates an instance of the ModelChange class |
+
+ void |
+setPreconditionQuery(java.lang.String preconditionQuery)
+
++ |
+
+ void |
+setPreconditionQueryType(RDFService.SPARQLQueryType queryType)
+
++ |
+
+Method Detail | +
---|
+java.lang.String getPreconditionQuery()+
+void setPreconditionQuery(java.lang.String preconditionQuery)+
preconditionQuery
- - a SPARQL query+RDFService.SPARQLQueryType getPreconditionQueryType()+
+void setPreconditionQueryType(RDFService.SPARQLQueryType queryType)+
queryType
- - the precondition query type+java.util.List<ModelChange> getModelChanges()+
+void addAddition(java.io.InputStream model, + RDFService.ModelSerializationFormat serializationFormat, + java.lang.String graphURI)+
+
model
- - a serialized RDF model (collection of triples)serializationFormat
- - format of the serialized RDF modelgraphURI
- - URI of the graph to which the RDF model should be added+void addRemoval(java.io.InputStream model, + RDFService.ModelSerializationFormat serializationFormat, + java.lang.String graphURI)+
+
model
- - a serialized RDF model (collection of triples)serializationFormat
- - format of the serialized RDF modelgraphURI
- - URI of the graph from which the RDF model should be removed+ModelChange manufactureModelChange()+
+
+ModelChange manufactureModelChange(java.io.InputStream serializedModel, + RDFService.ModelSerializationFormat serializationFormat, + ModelChange.Operation operation, + java.lang.String graphURI)+
+
serializedModel
- - a serialized RDF model (collection of triples)serializationFormat
- - format of the serialized RDF modeloperation
- - the type of operation to be performed with the serialized RDF modelgraphURI
- - URI of the graph on which to apply the model change operation
++void addPreChangeEvent(java.lang.Object event)+
+
event
- - event to notify listeners of in advance of making
+ changes to the triple store.+void addPostChangeEvent(java.lang.Object event)+
+
event
- - the event to notify listeners of after the changes are
+ performed.+java.util.List<java.lang.Object> getPreChangeEvents()+
+
+java.util.List<java.lang.Object> getPostChangeEvents()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+java.lang.Object ++java.lang.Enum<ModelChange.Operation> +
edu.cornell.mannlib.vitro.webapp.rdfservice.ModelChange.Operation +
public static enum ModelChange.Operation
+
+Enum Constant Summary | +|
---|---|
ADD
+
++ |
+|
REMOVE
+
++ |
+
+Method Summary | +|
---|---|
+static ModelChange.Operation |
+valueOf(java.lang.String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static ModelChange.Operation[] |
+values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
Methods inherited from class java.lang.Enum | +
---|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
+
Methods inherited from class java.lang.Object | +
---|
getClass, notify, notifyAll, wait, wait, wait |
+
+Enum Constant Detail | +
---|
+public static final ModelChange.Operation ADD+
+public static final ModelChange.Operation REMOVE+
+Method Detail | +
---|
+public static ModelChange.Operation[] values()+
+for (ModelChange.Operation c : ModelChange.Operation.values()) + System.out.println(c); ++
+
+public static ModelChange.Operation valueOf(java.lang.String name)+
+
name
- the name of the enum constant to be returned.
+java.lang.IllegalArgumentException
- if this enum type has no constant
+with the specified name
+java.lang.NullPointerException
- if the argument is null
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
public interface ModelChange
+A ModelChange is one component of a ChangeSet. + Represents a model (collection of RDF triples), the URI + of a graph, and an indication of whether to add or + remove the model from the graph. +
+ +
+
+Nested Class Summary | +|
---|---|
+static class |
+ModelChange.Operation
+
++ |
+
+Method Summary | +|
---|---|
+ java.lang.String |
+getGraphURI()
+
++ |
+
+ ModelChange.Operation |
+getOperation()
+
++ |
+
+ RDFService.ModelSerializationFormat |
+getSerializationFormat()
+
++ |
+
+ java.io.InputStream |
+getSerializedModel()
+
++ |
+
+ void |
+setGraphURI(java.lang.String graphURI)
+
++ |
+
+ void |
+setOperation(ModelChange.Operation operation)
+
++ |
+
+ void |
+setSerializationFormat(RDFService.ModelSerializationFormat serializationFormat)
+
++ |
+
+ void |
+setSerializedModel(java.io.InputStream serializedModel)
+
++ |
+
+Method Detail | +
---|
+java.io.InputStream getSerializedModel()+
+void setSerializedModel(java.io.InputStream serializedModel)+
serializedModel
- - the serialized model (collection of RDF triples) representing a change to make+RDFService.ModelSerializationFormat getSerializationFormat()+
+void setSerializationFormat(RDFService.ModelSerializationFormat serializationFormat)+
serializationFormat
- - the serialization format of the model+ModelChange.Operation getOperation()+
+void setOperation(ModelChange.Operation operation)+
operation
- - the operation to be performed+java.lang.String getGraphURI()+
+void setGraphURI(java.lang.String graphURI)+
graphURI
- - the URI of the graph to which to apply the change
+ If the graphURI is null the change applies to the
+ default write graph. If this method is not used to
+ set the write graph the default write graph will be used.
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+java.lang.Object ++java.lang.Enum<RDFService.ModelSerializationFormat> +
edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService.ModelSerializationFormat +
public static enum RDFService.ModelSerializationFormat
+
+Enum Constant Summary | +|
---|---|
N3
+
++ |
+|
RDFXML
+
++ |
+
+Method Summary | +|
---|---|
+static RDFService.ModelSerializationFormat |
+valueOf(java.lang.String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static RDFService.ModelSerializationFormat[] |
+values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
Methods inherited from class java.lang.Enum | +
---|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
+
Methods inherited from class java.lang.Object | +
---|
getClass, notify, notifyAll, wait, wait, wait |
+
+Enum Constant Detail | +
---|
+public static final RDFService.ModelSerializationFormat RDFXML+
+public static final RDFService.ModelSerializationFormat N3+
+Method Detail | +
---|
+public static RDFService.ModelSerializationFormat[] values()+
+for (RDFService.ModelSerializationFormat c : RDFService.ModelSerializationFormat.values()) + System.out.println(c); ++
+
+public static RDFService.ModelSerializationFormat valueOf(java.lang.String name)+
+
name
- the name of the enum constant to be returned.
+java.lang.IllegalArgumentException
- if this enum type has no constant
+with the specified name
+java.lang.NullPointerException
- if the argument is null
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+java.lang.Object ++java.lang.Enum<RDFService.ResultFormat> +
edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService.ResultFormat +
public static enum RDFService.ResultFormat
+
+Enum Constant Summary | +|
---|---|
CSV
+
++ |
+|
JSON
+
++ |
+|
TEXT
+
++ |
+|
XML
+
++ |
+
+Method Summary | +|
---|---|
+static RDFService.ResultFormat |
+valueOf(java.lang.String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static RDFService.ResultFormat[] |
+values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
Methods inherited from class java.lang.Enum | +
---|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
+
Methods inherited from class java.lang.Object | +
---|
getClass, notify, notifyAll, wait, wait, wait |
+
+Enum Constant Detail | +
---|
+public static final RDFService.ResultFormat JSON+
+public static final RDFService.ResultFormat CSV+
+public static final RDFService.ResultFormat XML+
+public static final RDFService.ResultFormat TEXT+
+Method Detail | +
---|
+public static RDFService.ResultFormat[] values()+
+for (RDFService.ResultFormat c : RDFService.ResultFormat.values()) + System.out.println(c); ++
+
+public static RDFService.ResultFormat valueOf(java.lang.String name)+
+
name
- the name of the enum constant to be returned.
+java.lang.IllegalArgumentException
- if this enum type has no constant
+with the specified name
+java.lang.NullPointerException
- if the argument is null
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+java.lang.Object ++java.lang.Enum<RDFService.SPARQLQueryType> +
edu.cornell.mannlib.vitro.webapp.rdfservice.RDFService.SPARQLQueryType +
public static enum RDFService.SPARQLQueryType
+
+Enum Constant Summary | +|
---|---|
ASK
+
++ |
+|
CONSTRUCT
+
++ |
+|
DESCRIBE
+
++ |
+|
SELECT
+
++ |
+
+Method Summary | +|
---|---|
+static RDFService.SPARQLQueryType |
+valueOf(java.lang.String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static RDFService.SPARQLQueryType[] |
+values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
Methods inherited from class java.lang.Enum | +
---|
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf |
+
Methods inherited from class java.lang.Object | +
---|
getClass, notify, notifyAll, wait, wait, wait |
+
+Enum Constant Detail | +
---|
+public static final RDFService.SPARQLQueryType SELECT+
+public static final RDFService.SPARQLQueryType CONSTRUCT+
+public static final RDFService.SPARQLQueryType DESCRIBE+
+public static final RDFService.SPARQLQueryType ASK+
+Method Detail | +
---|
+public static RDFService.SPARQLQueryType[] values()+
+for (RDFService.SPARQLQueryType c : RDFService.SPARQLQueryType.values()) + System.out.println(c); ++
+
+public static RDFService.SPARQLQueryType valueOf(java.lang.String name)+
+
name
- the name of the enum constant to be returned.
+java.lang.IllegalArgumentException
- if this enum type has no constant
+with the specified name
+java.lang.NullPointerException
- if the argument is null
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | ++DETAIL: ENUM CONSTANTS | FIELD | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
public interface RDFService
+Interface for API to write, read, and update Vitro's RDF store, with support + to allow listening, logging and auditing. +
+ +
+
+Nested Class Summary | +|
---|---|
+static class |
+RDFService.ModelSerializationFormat
+
++ |
+
+static class |
+RDFService.ResultFormat
+
++ |
+
+static class |
+RDFService.SPARQLQueryType
+
++ |
+
+Method Summary | +|
---|---|
+ boolean |
+changeSetUpdate(ChangeSet changeSet)
+
++ Performs a series of additions to and or removals from specified graphs + in the RDF store. |
+
+ void |
+close()
+
++ Frees any resources held by this RDFService object + + The implementation of this method should be idempotent so that + multiple invocations do not cause an error. |
+
+ java.lang.String |
+getDefaultWriteGraphURI()
+
++ Returns the URI of the default write graph |
+
+ void |
+getGraphMetadata()
+
++ To be determined. |
+
+ java.util.List<java.lang.String> |
+getGraphURIs()
+
++ Returns a list of all the graph URIs in the RDF store. |
+
+ ChangeSet |
+manufactureChangeSet()
+
++ Creates a ChangeSet object |
+
+ void |
+newIndividual(java.lang.String individualURI,
+ java.lang.String individualTypeURI)
+
++ If the given individual already exists in the default write graph, throws an + RDFServiceException, otherwise adds one type assertion to the default write + graph. |
+
+ void |
+newIndividual(java.lang.String individualURI,
+ java.lang.String individualTypeURI,
+ java.lang.String graphURI)
+
++ If the given individual already exists in the given graph, throws an + RDFServiceException, otherwise adds one type assertion to the given + graph. |
+
+ void |
+registerListener(ChangeListener changeListener)
+
++ Registers a listener to listen to changes in any graph in + the RDF store. |
+
+ boolean |
+sparqlAskQuery(java.lang.String query)
+
++ Performs a SPARQL ASK query against the knowledge base. |
+
+ java.io.InputStream |
+sparqlConstructQuery(java.lang.String query,
+ RDFService.ModelSerializationFormat resultFormat)
+
++ Performs a SPARQL construct query against the knowledge base. |
+
+ java.io.InputStream |
+sparqlDescribeQuery(java.lang.String query,
+ RDFService.ModelSerializationFormat resultFormat)
+
++ Performs a SPARQL describe query against the knowledge base. |
+
+ java.io.InputStream |
+sparqlSelectQuery(java.lang.String query,
+ RDFService.ResultFormat resultFormat)
+
++ Performs a SPARQL select query against the knowledge base. |
+
+ void |
+unregisterListener(ChangeListener changeListener)
+
++ Unregisters a listener from listening to changes in + any graph in the RDF store |
+
+Method Detail | +
---|
+boolean changeSetUpdate(ChangeSet changeSet) + throws RDFServiceException+
+
changeSet
- - a set of changes to be performed on the RDF store.
+RDFServiceException
+void newIndividual(java.lang.String individualURI, + java.lang.String individualTypeURI) + throws RDFServiceException+
+
individualURI
- - URI of the individual to be addedindividualTypeURI
- - URI of the type for the individual
+RDFServiceException
+void newIndividual(java.lang.String individualURI, + java.lang.String individualTypeURI, + java.lang.String graphURI) + throws RDFServiceException+
+
individualURI
- - URI of the individual to be addedindividualTypeURI
- - URI of the type for the individualgraphURI
- - URI of the graph to which to add the individual
+RDFServiceException
+java.io.InputStream sparqlConstructQuery(java.lang.String query, + RDFService.ModelSerializationFormat resultFormat) + throws RDFServiceException+
+
query
- - the SPARQL query to be executed against the RDF storeresultFormat
- - type of serialization for RDF result of the SPARQL query
+RDFServiceException
+java.io.InputStream sparqlDescribeQuery(java.lang.String query, + RDFService.ModelSerializationFormat resultFormat) + throws RDFServiceException+
+
query
- - the SPARQL query to be executed against the RDF storeresultFormat
- - type of serialization for RDF result of the SPARQL query
+RDFServiceException
+java.io.InputStream sparqlSelectQuery(java.lang.String query, + RDFService.ResultFormat resultFormat) + throws RDFServiceException+
+
query
- - the SPARQL query to be executed against the RDF storeresultFormat
- - format for the result of the Select query
+RDFServiceException
+boolean sparqlAskQuery(java.lang.String query) + throws RDFServiceException+
+
query
- - the SPARQL ASK query to be executed against the RDF store
+RDFServiceException
+java.util.List<java.lang.String> getGraphURIs() + throws RDFServiceException+
+
RDFServiceException
+void getGraphMetadata() + throws RDFServiceException+
+
RDFServiceException
+java.lang.String getDefaultWriteGraphURI() + throws RDFServiceException+
+
RDFServiceException
+void registerListener(ChangeListener changeListener) + throws RDFServiceException+
+
changeListener
- - the change listener
+RDFServiceException
+void unregisterListener(ChangeListener changeListener) + throws RDFServiceException+
+
changeListener
- - the change listener
+RDFServiceException
+ChangeSet manufactureChangeSet()+
+
+void close()+
+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+java.lang.Object ++java.lang.Throwable +
java.lang.Exception +
edu.cornell.mannlib.vitro.webapp.rdfservice.RDFServiceException +
public class RDFServiceException
+
+Constructor Summary | +|
---|---|
RDFServiceException()
+
++ |
+|
RDFServiceException(java.lang.String message)
+
++ |
+|
RDFServiceException(java.lang.String message,
+ java.lang.Throwable cause)
+
++ |
+|
RDFServiceException(java.lang.Throwable cause)
+
++ |
+
+Method Summary | +
---|
Methods inherited from class java.lang.Throwable | +
---|
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString |
+
Methods inherited from class java.lang.Object | +
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
+
+Constructor Detail | +
---|
+public RDFServiceException()+
+public RDFServiceException(java.lang.Throwable cause)+
+public RDFServiceException(java.lang.String message)+
+public RDFServiceException(java.lang.String message, + java.lang.Throwable cause)+
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
public interface RDFServiceFactory
+
+Method Summary | +|
---|---|
+ RDFService |
+getRDFService()
+
++ |
+
+ void |
+registerListener(ChangeListener changeListener)
+
++ Registers a listener to listen to changes in any graph in + the RDF store. |
+
+ void |
+unregisterListener(ChangeListener changeListener)
+
++ Unregisters a listener from listening to changes in the RDF store. |
+
+Method Detail | +
---|
+RDFService getRDFService()+
+void registerListener(ChangeListener changeListener) + throws RDFServiceException+
+
changeListener
- - the change listener
+RDFServiceException
+void unregisterListener(ChangeListener changeListener) + throws RDFServiceException+
+
changeListener
- - the change listener
+RDFServiceException
+
+
|
++ + | +||||||||
+ PREV CLASS + NEXT CLASS | ++ FRAMES + NO FRAMES + + + + + | +||||||||
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD | ++DETAIL: FIELD | CONSTR | METHOD | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ChangeListener in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice with parameters of type ChangeListener | +|
---|---|
+ void |
+RDFServiceFactory.registerListener(ChangeListener changeListener)
+
++ Registers a listener to listen to changes in any graph in + the RDF store. |
+
+ void |
+RDFService.registerListener(ChangeListener changeListener)
+
++ Registers a listener to listen to changes in any graph in + the RDF store. |
+
+ void |
+RDFServiceFactory.unregisterListener(ChangeListener changeListener)
+
++ Unregisters a listener from listening to changes in the RDF store. |
+
+ void |
+RDFService.unregisterListener(ChangeListener changeListener)
+
++ Unregisters a listener from listening to changes in + any graph in the RDF store |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ChangeSet in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that return ChangeSet | +|
---|---|
+ ChangeSet |
+RDFService.manufactureChangeSet()
+
++ Creates a ChangeSet object |
+
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice with parameters of type ChangeSet | +|
---|---|
+ boolean |
+RDFService.changeSetUpdate(ChangeSet changeSet)
+
++ Performs a series of additions to and or removals from specified graphs + in the RDF store. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ModelChange.Operation in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that return ModelChange.Operation | +|
---|---|
+ ModelChange.Operation |
+ModelChange.getOperation()
+
++ |
+
+static ModelChange.Operation |
+ModelChange.Operation.valueOf(java.lang.String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static ModelChange.Operation[] |
+ModelChange.Operation.values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice with parameters of type ModelChange.Operation | +|
---|---|
+ ModelChange |
+ChangeSet.manufactureModelChange(java.io.InputStream serializedModel,
+ RDFService.ModelSerializationFormat serializationFormat,
+ ModelChange.Operation operation,
+ java.lang.String graphURI)
+
++ Creates an instance of the ModelChange class |
+
+ void |
+ModelChange.setOperation(ModelChange.Operation operation)
+
++ |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of ModelChange in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that return ModelChange | +|
---|---|
+ ModelChange |
+ChangeSet.manufactureModelChange()
+
++ Creates an instance of the ModelChange class |
+
+ ModelChange |
+ChangeSet.manufactureModelChange(java.io.InputStream serializedModel,
+ RDFService.ModelSerializationFormat serializationFormat,
+ ModelChange.Operation operation,
+ java.lang.String graphURI)
+
++ Creates an instance of the ModelChange class |
+
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that return types with arguments of type ModelChange | +|
---|---|
+ java.util.List<ModelChange> |
+ChangeSet.getModelChanges()
+
++ |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of RDFService.ModelSerializationFormat in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that return RDFService.ModelSerializationFormat | +|
---|---|
+ RDFService.ModelSerializationFormat |
+ModelChange.getSerializationFormat()
+
++ |
+
+static RDFService.ModelSerializationFormat |
+RDFService.ModelSerializationFormat.valueOf(java.lang.String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static RDFService.ModelSerializationFormat[] |
+RDFService.ModelSerializationFormat.values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice with parameters of type RDFService.ModelSerializationFormat | +|
---|---|
+ void |
+ChangeSet.addAddition(java.io.InputStream model,
+ RDFService.ModelSerializationFormat serializationFormat,
+ java.lang.String graphURI)
+
++ Adds one model change representing an addition to the list of model changes |
+
+ void |
+ChangeSet.addRemoval(java.io.InputStream model,
+ RDFService.ModelSerializationFormat serializationFormat,
+ java.lang.String graphURI)
+
++ Adds one model change representing a deletion to the list of model changes |
+
+ ModelChange |
+ChangeSet.manufactureModelChange(java.io.InputStream serializedModel,
+ RDFService.ModelSerializationFormat serializationFormat,
+ ModelChange.Operation operation,
+ java.lang.String graphURI)
+
++ Creates an instance of the ModelChange class |
+
+ void |
+ModelChange.setSerializationFormat(RDFService.ModelSerializationFormat serializationFormat)
+
++ |
+
+ java.io.InputStream |
+RDFService.sparqlConstructQuery(java.lang.String query,
+ RDFService.ModelSerializationFormat resultFormat)
+
++ Performs a SPARQL construct query against the knowledge base. |
+
+ java.io.InputStream |
+RDFService.sparqlDescribeQuery(java.lang.String query,
+ RDFService.ModelSerializationFormat resultFormat)
+
++ Performs a SPARQL describe query against the knowledge base. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of RDFService.ResultFormat in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that return RDFService.ResultFormat | +|
---|---|
+static RDFService.ResultFormat |
+RDFService.ResultFormat.valueOf(java.lang.String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static RDFService.ResultFormat[] |
+RDFService.ResultFormat.values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice with parameters of type RDFService.ResultFormat | +|
---|---|
+ java.io.InputStream |
+RDFService.sparqlSelectQuery(java.lang.String query,
+ RDFService.ResultFormat resultFormat)
+
++ Performs a SPARQL select query against the knowledge base. |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of RDFService.SPARQLQueryType in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that return RDFService.SPARQLQueryType | +|
---|---|
+ RDFService.SPARQLQueryType |
+ChangeSet.getPreconditionQueryType()
+
++ |
+
+static RDFService.SPARQLQueryType |
+RDFService.SPARQLQueryType.valueOf(java.lang.String name)
+
++ Returns the enum constant of this type with the specified name. |
+
+static RDFService.SPARQLQueryType[] |
+RDFService.SPARQLQueryType.values()
+
++ Returns an array containing the constants of this enum type, in +the order they are declared. |
+
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice with parameters of type RDFService.SPARQLQueryType | +|
---|---|
+ void |
+ChangeSet.setPreconditionQueryType(RDFService.SPARQLQueryType queryType)
+
++ |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of RDFService in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that return RDFService | +|
---|---|
+ RDFService |
+RDFServiceFactory.getRDFService()
+
++ |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Uses of RDFServiceException in edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+ +
Methods in edu.cornell.mannlib.vitro.webapp.rdfservice that throw RDFServiceException | +|
---|---|
+ boolean |
+RDFService.changeSetUpdate(ChangeSet changeSet)
+
++ Performs a series of additions to and or removals from specified graphs + in the RDF store. |
+
+ java.lang.String |
+RDFService.getDefaultWriteGraphURI()
+
++ Returns the URI of the default write graph |
+
+ void |
+RDFService.getGraphMetadata()
+
++ To be determined. |
+
+ java.util.List<java.lang.String> |
+RDFService.getGraphURIs()
+
++ Returns a list of all the graph URIs in the RDF store. |
+
+ void |
+RDFService.newIndividual(java.lang.String individualURI,
+ java.lang.String individualTypeURI)
+
++ If the given individual already exists in the default write graph, throws an + RDFServiceException, otherwise adds one type assertion to the default write + graph. |
+
+ void |
+RDFService.newIndividual(java.lang.String individualURI,
+ java.lang.String individualTypeURI,
+ java.lang.String graphURI)
+
++ If the given individual already exists in the given graph, throws an + RDFServiceException, otherwise adds one type assertion to the given + graph. |
+
+ void |
+RDFServiceFactory.registerListener(ChangeListener changeListener)
+
++ Registers a listener to listen to changes in any graph in + the RDF store. |
+
+ void |
+RDFService.registerListener(ChangeListener changeListener)
+
++ Registers a listener to listen to changes in any graph in + the RDF store. |
+
+ boolean |
+RDFService.sparqlAskQuery(java.lang.String query)
+
++ Performs a SPARQL ASK query against the knowledge base. |
+
+ java.io.InputStream |
+RDFService.sparqlConstructQuery(java.lang.String query,
+ RDFService.ModelSerializationFormat resultFormat)
+
++ Performs a SPARQL construct query against the knowledge base. |
+
+ java.io.InputStream |
+RDFService.sparqlDescribeQuery(java.lang.String query,
+ RDFService.ModelSerializationFormat resultFormat)
+
++ Performs a SPARQL describe query against the knowledge base. |
+
+ java.io.InputStream |
+RDFService.sparqlSelectQuery(java.lang.String query,
+ RDFService.ResultFormat resultFormat)
+
++ Performs a SPARQL select query against the knowledge base. |
+
+ void |
+RDFServiceFactory.unregisterListener(ChangeListener changeListener)
+
++ Unregisters a listener from listening to changes in the RDF store. |
+
+ void |
+RDFService.unregisterListener(ChangeListener changeListener)
+
++ Unregisters a listener from listening to changes in + any graph in the RDF store |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Interfaces
+
+ +ChangeListener + +ChangeSet + +ModelChange + +RDFService + +RDFServiceFactory |
+
+Enums
+
+ +ModelChange.Operation + +RDFService.ModelSerializationFormat + +RDFService.ResultFormat + +RDFService.SPARQLQueryType |
+
+Exceptions
+
+ +RDFServiceException |
+
+
+
|
++ + | +||||||||
+ PREV PACKAGE + NEXT PACKAGE | ++ FRAMES + NO FRAMES + + + + + | +
+Interface Summary | +|
---|---|
ChangeListener | +An interface for listening to triples that are added to or removed + from the triple store, and other miscellaneous events. | +
ChangeSet | +Input parameter to changeSetUpdate() method in RDFService. | +
ModelChange | +A ModelChange is one component of a ChangeSet. | +
RDFService | +Interface for API to write, read, and update Vitro's RDF store, with support + to allow listening, logging and auditing. | +
RDFServiceFactory | ++ |
+ +
+Enum Summary | +|
---|---|
ModelChange.Operation | ++ |
RDFService.ModelSerializationFormat | ++ |
RDFService.ResultFormat | ++ |
RDFService.SPARQLQueryType | ++ |
+ +
+Exception Summary | +|
---|---|
RDFServiceException | ++ |
+
+
+
|
++ + | +||||||||
+ PREV PACKAGE + NEXT PACKAGE | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Classes in edu.cornell.mannlib.vitro.webapp.rdfservice used by edu.cornell.mannlib.vitro.webapp.rdfservice | +|
---|---|
ChangeListener
+
+ + An interface for listening to triples that are added to or removed + from the triple store, and other miscellaneous events. |
+|
ChangeSet
+
+ + Input parameter to changeSetUpdate() method in RDFService. |
+|
ModelChange
+
+ + A ModelChange is one component of a ChangeSet. |
+|
ModelChange.Operation
+
+ + |
+|
RDFService
+
+ + Interface for API to write, read, and update Vitro's RDF store, with support + to allow listening, logging and auditing. |
+|
RDFService.ModelSerializationFormat
+
+ + |
+|
RDFService.ResultFormat
+
+ + |
+|
RDFService.SPARQLQueryType
+
+ + |
+|
RDFServiceException
+
+ + |
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+ +++Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
+
+- Interfaces (italic)
- Classes
- Enums
- Exceptions
- Errors
- Annotation Types
+ ++ ++Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
+
+Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description +
+
- Nested Class Summary
- Field Summary
- Constructor Summary
- Method Summary +
+
- Field Detail
- Constructor Detail
- Method Detail
+ ++ ++Each annotation type has its own separate page with the following sections:
+
+- Annotation Type declaration
- Annotation Type description
- Required Element Summary
- Optional Element Summary
- Element Detail
+ +++Each enum has its own separate page with the following sections:
+
+- Enum declaration
- Enum description
- Enum Constant Summary
- Enum Constant Detail
+Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.+
+There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with+java.lang.Object
. The interfaces do not inherit fromjava.lang.Object
.+
+- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
+The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.+
+The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.+
+
+
+
+
+This help file applies to API documentation generated using the standard doclet.
+
+
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV LETTER + NEXT LETTER | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +
+Package edu.cornell.mannlib.vitro.webapp.rdfservice | +
---|
+Class edu.cornell.mannlib.vitro.webapp.rdfservice.RDFServiceException extends java.lang.Exception implements Serializable | +
---|
+ +
+
+
+
|
++ + | +||||||||
+ PREV + NEXT | ++ FRAMES + NO FRAMES + + + + + | +