Author: chathura
Date: Wed Jan 16 20:16:07 2008
New Revision: 12366
Log:
Added java docs.
Modified:
trunk/registry/modules/core/src/main/java/org/wso2/registry/jdbc/queries/QueryProcessor.java
Modified:
trunk/registry/modules/core/src/main/java/org/wso2/registry/jdbc/queries/QueryProcessor.java
==============================================================================
---
trunk/registry/modules/core/src/main/java/org/wso2/registry/jdbc/queries/QueryProcessor.java
(original)
+++
trunk/registry/modules/core/src/main/java/org/wso2/registry/jdbc/queries/QueryProcessor.java
Wed Jan 16 20:16:07 2008
@@ -24,6 +24,13 @@
import java.sql.Connection;
import java.util.Map;
+/**
+ * All query processors should extend this class. All configured query
processor implementations
+ * will be associated with a query type. Once an execute opration is called
for a query of that
+ * type, the associated query processor is invoked. Then all the tasks
required for processing that
+ * query should be taken over by the query processor implementation. This
processing steps include
+ * interpreting of given query parameters, constructing the resulting resource
object, etc.
+ */
public abstract class QueryProcessor {
protected DataSource dataSource;
@@ -34,6 +41,14 @@
this.realm = realm;
}
+ /**
+ * This method will be called when a query of a registered type is
executed.
+ *
+ * @param query query resource, possibly containing the query string
+ * @param parameters query parameters as name->value pairs
+ * @return
+ * @throws RegistryException
+ */
public abstract Resource executeQuery(Resource query, Map parameters)
throws RegistryException;
}
_______________________________________________
Registry-dev mailing list
[email protected]
http://wso2.org/cgi-bin/mailman/listinfo/registry-dev
