litvinovg/vitro
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

updating comments in java files

Browse source
This commit is contained in:
stellamit 2012-05-31 18:13:35 +00:00
parent 1c0d05175e
commit 8aa257d564
4 changed files with 48 additions and 48 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
webapp/src/edu/cornell/mannlib/vitro/webapp/rdfservice/ChangeListener.java
View file

@ -14,24 +14,24 @@ public interface ChangeListener {
/**
* Override this to listen to all statements added to the RDF store.
*
* @param String serializedTriple - the added statement in n3 format
* @param String graphURI - the graph to which the statement was added
* @param serializedTriple - the added statement in n3 format
* @param graphURI - the graph to which the statement was added
*/
public void addedStatement(String serializedTriple, String graphURI);
/**
* Override this to listen to all statements removed from the RDF store.
*
* @param String serializedTriple - the removed statement in n3 format
* @param String graphURI - the graph from which the statement was removed
* @param serializedTriple - the removed statement in n3 format
* @param graphURI - the graph from which the statement was removed
*/
public void removedStatement(String serializedTriple, String graphURI);
/**
* Override this to listen to events pertaining to the given graphURI.
*
* @param String graphURI - the graph to which the event pertains
* @param Object event - the event which occurred.
* @param graphURI - the graph to which the event pertains
* @param event - the event that occurred.
*/
public void notifyEvent(String graphURI, Object event);
}

28
webapp/src/edu/cornell/mannlib/vitro/webapp/rdfservice/ChangeSet.java
View file

@ -22,7 +22,7 @@ public interface ChangeSet {
/**
* Setter for the precondition query
*
* @param String - a SPARQL query
* @param preconditionQuery - a SPARQL query
*/
public void setPreconditionQuery(String preconditionQuery);
@ -36,7 +36,7 @@ public interface ChangeSet {
/**
* Setter for the precondition query type
*
* @param RDFService.SPARQLQueryType - the precondition query type
* @param queryType - the precondition query type
*/
public void setPreconditionQueryType(RDFService.SPARQLQueryType queryType);
@ -50,23 +50,23 @@ public interface ChangeSet {
/**
* Adds one model change representing an addition to the list of model changes
*
* @param InputStream - a serialized RDF model (collection of triples)
* @param RDFService.ModelSerializationFormat - format of the serialized RDF model
* @param String - URI of the graph to which the RDF model should be added
* @param model - a serialized RDF model (collection of triples)
* @param serializationFormat - format of the serialized RDF model
* @param graphURI - URI of the graph to which the RDF model should be added
*/
public void addAddition(InputStream model,
RDFService.ModelSerializationFormat format,
RDFService.ModelSerializationFormat serializationFormat,
String graphURI);
/**
* Adds one model change representing a deletion to the list of model changes
*
* @param InputStream - a serialized RDF model (collection of triples)
* @param RDFService.ModelSerializationFormat - format of the serialized RDF model
* @param String - URI of the graph from which the RDF model should be removed
* @param model - a serialized RDF model (collection of triples)
* @param serializationFormat - format of the serialized RDF model
* @param graphURI - URI of the graph from which the RDF model should be removed
*/
public void addRemoval(InputStream model,
RDFService.ModelSerializationFormat format,
RDFService.ModelSerializationFormat serializationFormat,
String graphURI);
/**
@ -77,10 +77,10 @@ public interface ChangeSet {
/**
* Creates an instance of the ModelChange class
*
* @param InputStream - a serialized RDF model (collection of triples)
* @param RDFService.ModelSerializationFormat - format of the serialized RDF model
* @param ModelChange.Operation - the type of operation to be performed with the serialized RDF model
* @param String - URI of the graph on which to apply the model change operation
* @param serializedModel - a serialized RDF model (collection of triples)
* @param serializationFormat - format of the serialized RDF model
* @param operation - the type of operation to be performed with the serialized RDF model
* @param graphURI - URI of the graph on which to apply the model change operation
*/
public ModelChange manufactureModelChange(InputStream serializedModel,
RDFService.ModelSerializationFormat serializationFormat,

14
webapp/src/edu/cornell/mannlib/vitro/webapp/rdfservice/ModelChange.java
View file

@ -18,14 +18,14 @@ public interface ModelChange {
/**
* Getter for the serialized model
*
* @return InputStream - a model (collection of RDF triples), serialized
* @return InputStream - a serialized model (collection of RDF triples) representing a change to make
*/
public InputStream getSerializedModel();
/**
* Setter for the serialized model
*
* @param InputStream - a model (collection of RDF triples), serialized
* @param serializedModel - a serialized model (collection of RDF triples) representing a change to make
*/
public void setSerializedModel(InputStream serializedModel);
@ -39,35 +39,35 @@ public interface ModelChange {
/**
* Setter for the serialization format of the model
*
* @param RDFService.ModelSerializationFormat - the serialization format of the model
* @param serializationFormat - the serialization format of the model
*/
public void setSerializationFormat(RDFService.ModelSerializationFormat serializationFormat);
/**
* Getter for the operation type
*
* @return ModelChange.Operation - the operation type
* @return ModelChange.Operation - the operation to be performed
*/
public ModelChange.Operation getOperation();
/**
* Setter for the operation type
*
* @param ModelChange.Operation - the operation type
* @param operation - the operation to be performed
*/
public void setOperation(ModelChange.Operation operation);
/**
* Getter for the URI of the graph to which to apply the change
*
* @return String - the graph URI
* @return String - the URI of the graph to which to apply the change
*/
public String getGraphURI();
/**
* Setter for the URI of the graph to which to apply the change
*
* @param String - the graph URI
* @param graphURI - the URI of the graph to which to apply the change
*/
public void setGraphURI(String graphURI);
}

42
webapp/src/edu/cornell/mannlib/vitro/webapp/rdfservice/RDFService.java
View file

@ -31,7 +31,7 @@ public interface RDFService {
* If the precondition query returns a non-empty result, no updates
* will be made.
*
* @param ChangeSet - a set of changes to be performed on the RDF store.
* @param changeSet - a set of changes to be performed on the RDF store.
*
* @return boolean - indicates whether the precondition was satisfied
*/
@ -42,8 +42,8 @@ public interface RDFService {
* RDFServiceException, otherwise adds one type assertion to the default
* graph.
*
* @param String individualURI - URI of the individual to be added
* @param String individualTypeURI - URI of the type for the individual
* @param individualURI - URI of the individual to be added
* @param individualTypeURI - URI of the type for the individual
*/
public void newIndividual(String individualURI, String individualTypeURI) throws RDFServiceException;
@ -52,9 +52,9 @@ public interface RDFService {
* RDFServiceException, otherwise adds one type assertion to the given
* graph.
*
* @param String individualURI - URI of the individual to be added
* @param String individualTypeURI - URI of the type for the individual
* @param String graphURI - URI of the graph to which to add the individual
* @param individualURI - URI of the individual to be added
* @param individualTypeURI - URI of the type for the individual
* @param graphURI - URI of the graph to which to add the individual
*/
public void newIndividual(String individualURI, String individualTypeURI, String graphURI) throws RDFServiceException;
@ -62,9 +62,10 @@ public interface RDFService {
* Performs a SPARQL construct query against the knowledge base. The query may have
* an embedded graph identifier.
*
* @param String query - the SPARQL query to be executed against the RDF store
* @param RDFService.ModelSerializationFormat resultFormat - type of serialization for RDF result of the SPARQL query
* @param OutputStream outputStream - the result of the query
* @param query - the SPARQL query to be executed against the RDF store
* @param resultFormat - type of serialization for RDF result of the SPARQL query
*
* @return InputStream - the result of the query
*
*/
public InputStream sparqlConstructQuery(String query, RDFService.ModelSerializationFormat resultFormat) throws RDFServiceException;
@ -73,8 +74,8 @@ public interface RDFService {
* Performs a SPARQL describe query against the knowledge base. The query may have
* an embedded graph identifier.
*
* @param String query - the SPARQL query to be executed against the RDF store
* @param RDFService.ModelSerializationFormat resultFormat - type of serialization for RDF result of the SPARQL query
* @param query - the SPARQL query to be executed against the RDF store
* @param resultFormat - type of serialization for RDF result of the SPARQL query
*
* @return InputStream - the result of the query
*
@ -85,8 +86,8 @@ public interface RDFService {
* Performs a SPARQL select query against the knowledge base. The query may have
* an embedded graph identifier.
*
* @param String query - the SPARQL query to be executed against the RDF store
* @param RDFService.ResultFormat resultFormat - format for the result of the Select query
* @param query - the SPARQL query to be executed against the RDF store
* @param resultFormat - format for the result of the Select query
*
* @return InputStream - the result of the query
*
@ -97,7 +98,7 @@ public interface RDFService {
* Performs a SPARQL ASK query against the knowledge base. The query may have
* an embedded graph identifier.
*
* @param String query - the SPARQL query to be executed against the RDF store
* @param query - the SPARQL query to be executed against the RDF store
*
* @return boolean - the result of the SPARQL query
*/
@ -112,8 +113,7 @@ public interface RDFService {
public List<String> getGraphURIs() throws RDFServiceException;
/**
* TODO - what is the definition of this method?
* @return
* TBD - we need to define this method
*/
public void getGraphMetadata() throws RDFServiceException;
@ -128,22 +128,22 @@ public interface RDFService {
* Register a listener to listen to changes in any graph in
* the RDF store.
*
* @return String URI of default read graph
* @param changeListener - the change listener
*/
public void registerListener(ChangeListener changeListener) throws RDFServiceException;
/**
* Unregister a listener to listen to changes in any graph in
* the RDF store.
* Unregister a listener from listening to changes in
* the RDF store in any graph.
*
* @return String URI of default read graph
* @param changeListener - the change listener
*/
public void unregisterListener(ChangeListener changeListener) throws RDFServiceException;
/**
* Create a ChangeSet object
*
* @return a ChangeSet object
* @return ChangeSet an empty ChangeSet object
*/
public ChangeSet manufactureChangeSet();
}