java.util.PropertiesgetProperties()
-java.util.Map<java.lang.String,Resource>getResources()
ResultDataConvertergetResultDataConverter(ResultDataType dataType,
java.lang.String format)
java.util.Map<ResultDataType,java.util.List<DataConverterImplementation>>getResultDataConverters() java.lang.StringgetResultDataFolder()
+java.util.Map<java.lang.String,IRCTJoin>getSupportedJoinTypes()
@@ -235,19 +235,19 @@ voidsetProperties(java.util.Properties properties)
-setResources(java.util.Map<java.lang.String,Resource> resources)
+voidsetResources(java.util.Map<java.lang.String,Resource> resources)
-setResultDataConverters(java.util.Map<ResultDataType,java.util.List<DataConverterImplementation>> resultDataConverters) voidsetResultDataConverters(java.util.Map<ResultDataType,java.util.List<DataConverterImplementation>> resultDataConverters) setResultDataFolder(java.lang.String resultDataFolder)
+voidpublic java.util.Properties getProperties()-
public java.lang.String getResultDataFolder()+
public void setProperties(java.util.Properties properties)-
public void setResultDataFolder(java.lang.String resultDataFolder)+
properties - PropertiesresultDataFolder - Result Data Folderpublic interface Executable
-| Modifier and Type | -Method and Description | -
|---|---|
Resource |
-getResource()
-Returns the resource the executable will be run on
- |
-
ResultSet |
-getResults()
-Returns the result set
- |
-
ExecutableState |
-getState()
-Get the current state of the executable
- |
-
void |
-run()
-Run the executable
- |
-
void |
-setResource(Resource resource)
-Sets the resource this executable will be run on
- |
-
void |
-setup(Action action)
-Set up the executable with an action
- |
-
void setup(Action action)-
action - Action to be executedvoid run() - throws ResourceInterfaceException-
ResourceInterfaceException - An error occurredExecutableState getState()-
ResultSet getResults() - throws ResourceInterfaceException-
ResourceInterfaceException - An error occurredResource getResource()-
void setResource(Resource resource)-
resource - Resource to run onpublic enum ExecutableState -extends java.lang.Enum<ExecutableState>-
| Enum Constant and Description | -
|---|
BLOCKED
-Currently blocked
- |
-
COMPLETED
-The executable has completed
- |
-
CREATED
-Created but not running
- |
-
RUNNING
-Currently running
- |
-
TERMINATED
-The executable has been terminated
- |
-
WAITING
-Waiting for the next action
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
static ExecutableState |
-valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static ExecutableState[] |
-values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOfgetClass, notify, notifyAll, wait, wait, waitpublic static final ExecutableState CREATED-
public static final ExecutableState WAITING-
public static final ExecutableState RUNNING-
public static final ExecutableState BLOCKED-
public static final ExecutableState TERMINATED-
public static final ExecutableState COMPLETED-
public static ExecutableState[] values()-
-for (ExecutableState c : ExecutableState.values()) - System.out.println(c); -
public static ExecutableState 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 namejava.lang.NullPointerException - if the argument is nullpublic class ExecutionPlan
-extends java.lang.Object
-| Constructor and Description | -
|---|
ExecutionPlan() |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-getResults()
-Return the results of the execution plan if they are available
- |
-
ExecutableState |
-getState()
-Returns the current execution state
- |
-
void |
-run()
-Run the base execution plan
- |
-
void |
-setup(Executable executable)
-Setup the execution plan with the base executable
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(Executable executable)-
executable - Base executablepublic void run()-
public ResultSet getResults()-
public ExecutableState getState()-
public class JoinExecutable -extends java.lang.Object -implements Executable, BinaryTreeExecutable-
| Constructor and Description | -
|---|
JoinExecutable() |
-
| Modifier and Type | -Method and Description | -
|---|---|
Executable |
-getLeft()
-Returns the left executable
- |
-
Resource |
-getResource()
-Returns the resource the executable will be run on
- |
-
ResultSet |
-getResults()
-Returns the result set
- |
-
Executable |
-getRight()
-Returns the right executable
- |
-
ExecutableState |
-getState()
-Get the current state of the executable
- |
-
void |
-run()
-Run the executable
- |
-
void |
-setResource(Resource resource)
-Sets the resource this executable will be run on
- |
-
void |
-setup(Action action)
-Set up the executable with an action
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(Action action)-
Executablesetup in interface Executableaction - Action to be executedpublic void run()-
Executablerun in interface Executablepublic ExecutableState getState()-
ExecutablegetState in interface Executablepublic ResultSet getResults()-
ExecutablegetResults in interface Executablepublic Executable getLeft()-
BinaryTreeExecutablegetLeft in interface BinaryTreeExecutablepublic Executable getRight()-
BinaryTreeExecutablegetRight in interface BinaryTreeExecutablepublic void setResource(Resource resource)-
ExecutablesetResource in interface Executableresource - Resource to run onpublic Resource getResource()-
ExecutablegetResource in interface Executablepublic class ProcessExecutable -extends java.lang.Object -implements Executable, BinaryTreeExecutable-
| Constructor and Description | -
|---|
ProcessExecutable() |
-
| Modifier and Type | -Method and Description | -
|---|---|
Executable |
-getLeft()
-Returns the left executable
- |
-
Resource |
-getResource()
-Returns the resource the executable will be run on
- |
-
ResultSet |
-getResults()
-Returns the result set
- |
-
Executable |
-getRight()
-Returns the right executable
- |
-
ExecutableState |
-getState()
-Get the current state of the executable
- |
-
void |
-run()
-Run the executable
- |
-
void |
-setResource(Resource resource)
-Sets the resource this executable will be run on
- |
-
void |
-setup(Action action)
-Set up the executable with an action
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(Action action)-
Executablesetup in interface Executableaction - Action to be executedpublic void run() - throws ResourceInterfaceException-
Executablerun in interface ExecutableResourceInterfaceException - An error occurredpublic ResultSet getResults() - throws ResourceInterfaceException-
ExecutablegetResults in interface ExecutableResourceInterfaceException - An error occurredpublic Executable getLeft()-
BinaryTreeExecutablegetLeft in interface BinaryTreeExecutablepublic Executable getRight()-
BinaryTreeExecutablegetRight in interface BinaryTreeExecutablepublic ExecutableState getState()-
ExecutablegetState in interface Executablepublic void setResource(Resource resource)-
ExecutablesetResource in interface Executableresource - Resource to run onpublic Resource getResource()-
ExecutablegetResource in interface Executablepublic class QueryExecutable -extends java.lang.Object -implements Executable-
| Constructor and Description | -
|---|
QueryExecutable() |
-
| Modifier and Type | -Method and Description | -
|---|---|
Resource |
-getResource()
-Returns the resource the executable will be run on
- |
-
ResultSet |
-getResults()
-Returns the result set
- |
-
ExecutableState |
-getState()
-Get the current state of the executable
- |
-
void |
-run()
-Run the executable
- |
-
void |
-setResource(Resource resource)
-Sets the resource this executable will be run on
- |
-
void |
-setup(Action action)
-Set up the executable with an action
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(Action action)-
Executablesetup in interface Executableaction - Action to be executedpublic void run() - throws ResourceInterfaceException-
Executablerun in interface ExecutableResourceInterfaceException - An error occurredpublic ResultSet getResults() - throws ResourceInterfaceException-
ExecutablegetResults in interface ExecutableResourceInterfaceException - An error occurredpublic ExecutableState getState()-
ExecutablegetState in interface Executablepublic void setResource(Resource resource)-
ExecutablesetResource in interface Executableresource - Resource to run onpublic Resource getResource()-
ExecutablegetResource in interface Executable| Modifier and Type | +Method and Description | +
|---|---|
void |
+IRCTEventListener.afterAction(SecureSession session,
+ Action action)
+Runs the event listeners after an action is run
+ |
+
void |
+IRCTEventListener.beforeAction(SecureSession session,
+ Action action)
+Runs the event listeners before an action is run
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+BeforeAction.fire(SecureSession session,
+ Action action) |
+
void |
+AfterAction.fire(SecureSession session,
+ Action action) |
+
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.action | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.result | -- |
| Modifier and Type | -Class and Description | -
|---|---|
class |
-JoinExecutable
-The query executable implements the Executable interface for executing
- local joins.
- |
-
class |
-ProcessExecutable
-The query executable implements the Executable interface for executing
- processes.
- |
-
class |
-QueryExecutable
-The query executable implements the Executable interface for executing
- queries.
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
Executable |
-ProcessExecutable.getLeft() |
-
Executable |
-JoinExecutable.getLeft() |
-
Executable |
-BinaryTreeExecutable.getLeft()
-Returns the left executable
- |
-
Executable |
-ProcessExecutable.getRight() |
-
Executable |
-JoinExecutable.getRight() |
-
Executable |
-BinaryTreeExecutable.getRight()
-Returns the right executable
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-ExecutionPlan.setup(Executable executable)
-Setup the execution plan with the base executable
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
Executable |
-Result.getExecutable()
-Returns the executable used for the result
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-Result.setExecutable(Executable executable)
-Sets the executable used for the result
- |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.action | -- |
| Modifier and Type | -Method and Description | -
|---|---|
ExecutableState |
-QueryExecutable.getState() |
-
ExecutableState |
-ProcessExecutable.getState() |
-
ExecutableState |
-JoinExecutable.getState() |
-
ExecutableState |
-ExecutionPlan.getState()
-Returns the current execution state
- |
-
ExecutableState |
-Executable.getState()
-Get the current state of the executable
- |
-
static ExecutableState |
-ExecutableState.valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static ExecutableState[] |
-ExecutableState.values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
public class FullOuterJoin -extends java.lang.Object -implements JoinAction-
| Constructor and Description | -
|---|
FullOuterJoin() |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-getResults()
-Gets the results
- |
-
java.lang.String |
-getType()
-Returns the join type
- |
-
void |
-run()
-Runs the given action
- |
-
void |
-setJoins(Joinable... joinables)
-Sets the joinable resultSets that are to be combined and joins them.
- |
-
void |
-setup(java.util.Map<java.lang.String,java.lang.String> parameters)
-Sets up the join with the given parameters.
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(java.util.Map<java.lang.String,java.lang.String> parameters)-
JoinActionsetup in interface JoinActionparameters - Join Parameterspublic void setJoins(Joinable... joinables) - throws java.lang.Exception-
JoinActionsetJoins in interface JoinActionjoinables - All RrsultSets that are to be joinedjava.lang.Exception - An exception occurred joining the resultSetspublic void run()-
Actionpublic ResultSet getResults()-
ActiongetResults in interface Actionpublic java.lang.String getType()-
JoinActiongetType in interface JoinActionpublic javax.json.JsonObject toJson()-
JoinActiontoJson in interface JoinActionpublic javax.json.JsonObject toJson(int depth)-
JoinActiontoJson in interface JoinActiondepth - Depth to travelpublic class InnerJoin -extends java.lang.Object -implements JoinAction-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-getResults()
-Gets the results
- |
-
java.lang.String |
-getType()
-Returns the join type
- |
-
void |
-run()
-Runs the given action
- |
-
void |
-setJoins(Joinable... joinables)
-Sets the joinable resultSets that are to be combined and joins them.
- |
-
void |
-setup(java.util.Map<java.lang.String,java.lang.String> parameters)
-Sets up the join with the given parameters.
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(java.util.Map<java.lang.String,java.lang.String> parameters)-
JoinActionsetup in interface JoinActionparameters - Join Parameterspublic void setJoins(Joinable... joinables) - throws java.lang.Exception-
JoinActionsetJoins in interface JoinActionjoinables - All RrsultSets that are to be joinedjava.lang.Exception - An exception occurred joining the resultSetspublic void run()-
Actionpublic ResultSet getResults()-
ActiongetResults in interface Actionpublic java.lang.String getType()-
JoinActiongetType in interface JoinActionpublic javax.json.JsonObject toJson()-
JoinActiontoJson in interface JoinActionpublic javax.json.JsonObject toJson(int depth)-
JoinActiontoJson in interface JoinActiondepth - Depth to travelpublic interface JoinAction -extends Action-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-getType()
-Returns the join type
- |
-
void |
-setJoins(Joinable... joinables)
-Sets the joinable resultSets that are to be combined and joins them.
- |
-
void |
-setup(java.util.Map<java.lang.String,java.lang.String> parameters)
-Sets up the join with the given parameters.
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
getResults, runvoid setup(java.util.Map<java.lang.String,java.lang.String> parameters)-
parameters - Join Parametersvoid setJoins(Joinable... joinables) - throws java.lang.Exception-
joinables - All RrsultSets that are to be joinedjava.lang.Exception - An exception occurred joining the resultSetsjava.lang.String getType()-
javax.json.JsonObject toJson()-
javax.json.JsonObject toJson(int depth)-
depth - Depth to travelpublic class LeftOuterJoin -extends java.lang.Object -implements JoinAction-
| Constructor and Description | -
|---|
LeftOuterJoin() |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-getResults()
-Gets the results
- |
-
java.lang.String |
-getType()
-Returns the join type
- |
-
void |
-run()
-Runs the given action
- |
-
void |
-setJoins(Joinable... joinables)
-Sets the joinable resultSets that are to be combined and joins them.
- |
-
void |
-setup(java.util.Map<java.lang.String,java.lang.String> parameters)
-Sets up the join with the given parameters.
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(java.util.Map<java.lang.String,java.lang.String> parameters)-
JoinActionsetup in interface JoinActionparameters - Join Parameterspublic void setJoins(Joinable... joinables) - throws java.lang.Exception-
JoinActionsetJoins in interface JoinActionjoinables - All RrsultSets that are to be joinedjava.lang.Exception - An exception occurred joining the resultSetspublic void run()-
Actionpublic ResultSet getResults()-
ActiongetResults in interface Actionpublic java.lang.String getType()-
JoinActiongetType in interface JoinActionpublic javax.json.JsonObject toJson()-
JoinActiontoJson in interface JoinActionpublic javax.json.JsonObject toJson(int depth)-
JoinActiontoJson in interface JoinActiondepth - Depth to travelpublic class RightOuterJoin -extends java.lang.Object -implements JoinAction-
| Constructor and Description | -
|---|
RightOuterJoin() |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-getResults()
-Gets the results
- |
-
java.lang.String |
-getType()
-Returns the join type
- |
-
void |
-run()
-Runs the given action
- |
-
void |
-setJoins(Joinable... joinables)
-Sets the joinable resultSets that are to be combined and joins them.
- |
-
void |
-setup(java.util.Map<java.lang.String,java.lang.String> parameters)
-Sets up the join with the given parameters.
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(java.util.Map<java.lang.String,java.lang.String> parameters)-
JoinActionsetup in interface JoinActionparameters - Join Parameterspublic void setJoins(Joinable... joinables) - throws java.lang.Exception-
JoinActionsetJoins in interface JoinActionjoinables - All RrsultSets that are to be joinedjava.lang.Exception - An exception occurred joining the resultSetspublic void run()-
Actionpublic ResultSet getResults()-
ActiongetResults in interface Actionpublic java.lang.String getType()-
JoinActiongetType in interface JoinActionpublic javax.json.JsonObject toJson()-
JoinActiontoJson in interface JoinActionpublic javax.json.JsonObject toJson(int depth)-
JoinActiontoJson in interface JoinActiondepth - Depth to travel| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.action.join | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.query | -- |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | -- |
| Modifier and Type | -Class and Description | -
|---|---|
class |
-FullOuterJoin
-Performs a full outer join between two result sets that implements the
- Joinable interface
-
- NOTE: Currently returns a MemoryResultSet which may limit the size of joins
- that can be performed
- |
-
class |
-InnerJoin
-Performs a inner join between two result sets that implements the
- Joinable interface
-
- NOTE: Currently returns a MemoryResultSet which may limit the size of joins
- that can be performed
- |
-
class |
-LeftOuterJoin
-Performs a left outer join between two result sets that implements the
- Joinable interface
-
- NOTE: Currently returns a MemoryResultSet which may limit the size of joins
- that can be performed
- |
-
class |
-RightOuterJoin
-Performs a right outer join between two result sets that implements the
- Joinable interface
-
- NOTE: Currently returns a MemoryResultSet which may limit the size of joins
- that can be performed
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
JoinAction |
-JoinType.getJoinImplementation()
-Returns the implementing class of the join type
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-JoinType.setJoinImplementation(JoinAction joinImplementation)
-Sets the implementing class of the join type
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
JoinAction |
-JoinActionConverter.convertToEntityAttribute(java.lang.String className) |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-JoinActionConverter.convertToDatabaseColumn(JoinAction joinAction) |
-
| Class and Description | +
|---|
| Action
+ The action interface provides a set of basic functionality that all actions must
+ accomplish.
+ |
+
| Class and Description | +
|---|
| Action
+ The action interface provides a set of basic functionality that all actions must
+ accomplish.
+ |
+
public class ExecuteProcess -extends java.lang.Object -implements ProcessAction-
| Constructor and Description | -
|---|
ExecuteProcess() |
-
| Modifier and Type | -Method and Description | -
|---|---|
IRCTProcess |
-getProcess()
-Returns the process to be run
- |
-
ResultSet |
-getResults()
-Gets the results
- |
-
void |
-run()
-Runs the given action
- |
-
void |
-setProcess(IRCTProcess process)
-Sets the process to be run
- |
-
void |
-setup(Resource resource,
- IRCTProcess process)
-Sets up a process to be run on a specific resource
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(Resource resource, - IRCTProcess process)-
ProcessActionsetup in interface ProcessActionresource - Resource to run onprocess - Process to runpublic void run()-
Actionpublic ResultSet getResults() - throws ResourceInterfaceException-
ActiongetResults in interface ActionResourceInterfaceException - An error occurredpublic IRCTProcess getProcess()-
ProcessActiongetProcess in interface ProcessActionpublic void setProcess(IRCTProcess process)-
ProcessActionsetProcess in interface ProcessActionprocess - Process to be run| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.action.process | -- |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | -- |
| Modifier and Type | -Class and Description | -
|---|---|
class |
-ExecuteProcess
-Implements the ProcessAction interface to run a process
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ProcessAction |
-ProcessActionConverter.convertToEntityAttribute(java.lang.String className) |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-ProcessActionConverter.convertToDatabaseColumn(ProcessAction joinAction) |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.action.process | -- |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | -- |
| Class and Description | -
|---|
| ProcessAction
- This interface extends the action interface for running processes
- |
-
| Class and Description | -
|---|
| ProcessAction
- This interface extends the action interface for running processes
- |
-
public class ExecuteQuery -extends java.lang.Object -implements QueryAction-
| Constructor and Description | -
|---|
ExecuteQuery() |
-
| Modifier and Type | -Method and Description | -
|---|---|
Query |
-getQuery()
-Returns the query to be run
- |
-
ResultSet |
-getResults()
-Gets the results
- |
-
void |
-run()
-Runs the given action
- |
-
void |
-setQuery(Query query)
-Sets the query to be run
- |
-
void |
-setup(Resource resource,
- Query query)
-Sets up a query to be run on a specific resource
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void setup(Resource resource, - Query query)-
QueryActionsetup in interface QueryActionresource - Resource to run onquery - Query to runpublic void run() - throws ResourceInterfaceException-
Actionrun in interface ActionResourceInterfaceException - An error occurredpublic ResultSet getResults() - throws ResourceInterfaceException-
ActiongetResults in interface ActionResourceInterfaceException - An error occurredpublic Query getQuery()-
QueryActiongetQuery in interface QueryActionpublic void setQuery(Query query)-
QueryActionsetQuery in interface QueryActionquery - Query to be run| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.action.query | -- |
| Class and Description | -
|---|
| QueryAction
- This interface extends the action interface for running queries
- |
-
java.util.List<Entity>searchForOntology(Resource resource,
- Entity resourcePath,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-java.util.List<Entity>searchForTerm(Resource resource,
+searchForTerm(Resource resource,
Entity resourcePath,
- java.lang.String searchTerm,
+ FindInformationInterface findInformation,
SecureSession session)
Searches a resource for a given searchTerm.
java.util.List<Entity>traversePath(Resource resource,
Entity resourcePath,
@@ -251,7 +241,7 @@ traversePath
-
+
@@ -259,7 +249,7 @@ traversePath
searchForTerm
public java.util.List<Entity> searchForTerm(Resource resource,
Entity resourcePath,
- java.lang.String searchTerm,
+ FindInformationInterface findInformation,
SecureSession session)
throws ResourceInterfaceException
Searches a resource for a given searchTerm. If the resource is null it
@@ -277,35 +267,6 @@ searchForTerm
-
-
-
-
--
-
searchForOntology
-public java.util.List<Entity> searchForOntology(Resource resource,
- Entity resourcePath,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
- throws ResourceInterfaceException
-Searches a resource for a given ontology term from a given ontology. If
- the resource is null it searches all resources for that term regardless
- of path.
-
-- Parameters:
-resource - ResourceresourcePath - Resource PathontologyType - Ontology TypeontologyTerm - Ontology Termsession - Session to run it in- Returns:
-- Paths
-- Throws:
-ResourceInterfaceException - A resource interface exception occurred
-
-
diff --git a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/controller/ProcessController.html b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/controller/ProcessController.html
index 3889237..5853e08 100644
--- a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/controller/ProcessController.html
+++ b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/controller/ProcessController.html
@@ -2,9 +2,9 @@
-
+
ProcessController
-
+
diff --git a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/controller/QueryController.html b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/controller/QueryController.html
index 4d88b5d..0908f1e 100644
--- a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/controller/QueryController.html
+++ b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/controller/QueryController.html
@@ -2,9 +2,9 @@
-
+
QueryController
-
+
@@ -152,8 +152,11 @@ Method Summary
Method and Description
voidaddJoinClause()
+java.lang.LongaddJoinClause(java.lang.Long clauseId,
+ Resource resource,
+ JoinType joinType,
+ java.util.Map<java.lang.String,java.lang.String> joinFields)
public void addJoinClause() - throws QueryException+
public java.lang.Long addJoinClause(java.lang.Long clauseId, + Resource resource, + JoinType joinType, + java.util.Map<java.lang.String,java.lang.String> joinFields) + throws QueryException
QueryException - An occurred adding the join clausepublic class SecurityController
extends java.lang.Object
-public class CSVTabularDataConverter -extends java.lang.Object -implements ResultDataConverter-
| Constructor and Description | -
|---|
CSVTabularDataConverter() |
-
| Modifier and Type | -Method and Description | -
|---|---|
javax.ws.rs.core.StreamingOutput |
-createStream(Result result)
-Returns an output stream
- |
-
java.lang.String |
-getFileExtension()
-Returns the file extension that is typically associated with a file of that type
- |
-
java.lang.String |
-getMediaType()
-Returns the media type the converter supports
- |
-
java.lang.String |
-getName()
-Returns the name of the converter
- |
-
ResultDataType |
-getResultDataType()
-Returns the data type the data converter supports
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic CSVTabularDataConverter()-
public ResultDataType getResultDataType()-
ResultDataConvertergetResultDataType in interface ResultDataConverterpublic java.lang.String getFileExtension()-
ResultDataConvertergetFileExtension in interface ResultDataConverterpublic java.lang.String getName()-
ResultDataConvertergetName in interface ResultDataConverterpublic java.lang.String getMediaType()-
ResultDataConvertergetMediaType in interface ResultDataConverterpublic javax.ws.rs.core.StreamingOutput createStream(Result result)-
ResultDataConvertercreateStream in interface ResultDataConverterresult - Result to stream outpublic class JSONTabularDataConverter -extends java.lang.Object -implements ResultDataConverter-
| Constructor and Description | -
|---|
JSONTabularDataConverter() |
-
| Modifier and Type | -Method and Description | -
|---|---|
javax.ws.rs.core.StreamingOutput |
-createStream(Result result)
-Returns an output stream
- |
-
java.lang.String |
-getFileExtension()
-Returns the file extension that is typically associated with a file of that type
- |
-
java.lang.String |
-getMediaType()
-Returns the media type the converter supports
- |
-
java.lang.String |
-getName()
-Returns the name of the converter
- |
-
ResultDataType |
-getResultDataType()
-Returns the data type the data converter supports
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic JSONTabularDataConverter()-
public ResultDataType getResultDataType()-
ResultDataConvertergetResultDataType in interface ResultDataConverterpublic java.lang.String getFileExtension()-
ResultDataConvertergetFileExtension in interface ResultDataConverterpublic java.lang.String getName()-
ResultDataConvertergetName in interface ResultDataConverterpublic java.lang.String getMediaType()-
ResultDataConvertergetMediaType in interface ResultDataConverterpublic javax.ws.rs.core.StreamingOutput createStream(Result result)-
ResultDataConvertercreateStream in interface ResultDataConverterresult - Result to stream outpublic interface ResultDataConverter
@@ -274,7 +270,7 @@ public class XMLTabularDataConverter -extends java.lang.Object -implements ResultDataConverter-
| Constructor and Description | -
|---|
XMLTabularDataConverter() |
-
| Modifier and Type | -Method and Description | -
|---|---|
javax.ws.rs.core.StreamingOutput |
-createStream(Result result)
-Returns an output stream
- |
-
java.lang.String |
-getFileExtension()
-Returns the file extension that is typically associated with a file of that type
- |
-
java.lang.String |
-getMediaType()
-Returns the media type the converter supports
- |
-
java.lang.String |
-getName()
-Returns the name of the converter
- |
-
ResultDataType |
-getResultDataType()
-Returns the data type the data converter supports
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic XMLTabularDataConverter()-
public ResultDataType getResultDataType()-
ResultDataConvertergetResultDataType in interface ResultDataConverterpublic java.lang.String getFileExtension()-
ResultDataConvertergetFileExtension in interface ResultDataConverterpublic java.lang.String getName()-
ResultDataConvertergetName in interface ResultDataConverterpublic java.lang.String getMediaType()-
ResultDataConvertergetMediaType in interface ResultDataConverterpublic javax.ws.rs.core.StreamingOutput createStream(Result result)-
ResultDataConvertercreateStream in interface ResultDataConverterresult - Result to stream outpublic class XSLXTabularDataConverter -extends java.lang.Object -implements ResultDataConverter-
| Constructor and Description | -
|---|
XSLXTabularDataConverter() |
-
| Modifier and Type | -Method and Description | -
|---|---|
javax.ws.rs.core.StreamingOutput |
-createStream(Result result)
-Returns an output stream
- |
-
java.lang.String |
-getFileExtension()
-Returns the file extension that is typically associated with a file of that type
- |
-
java.lang.String |
-getMediaType()
-Returns the media type the converter supports
- |
-
java.lang.String |
-getName()
-Returns the name of the converter
- |
-
ResultDataType |
-getResultDataType()
-Returns the data type the data converter supports
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic XSLXTabularDataConverter()-
public ResultDataType getResultDataType()-
ResultDataConvertergetResultDataType in interface ResultDataConverterpublic java.lang.String getFileExtension()-
ResultDataConvertergetFileExtension in interface ResultDataConverterpublic java.lang.String getName()-
ResultDataConvertergetName in interface ResultDataConverterpublic java.lang.String getMediaType()-
ResultDataConvertergetMediaType in interface ResultDataConverterpublic javax.ws.rs.core.StreamingOutput createStream(Result result)-
ResultDataConvertercreateStream in interface ResultDataConverterresult - Result to stream out| Modifier and Type | -Class and Description | -
|---|---|
class |
-CSVTabularDataConverter
-A data converter that returns a CSV Stream
- |
-
class |
-JSONTabularDataConverter
-A data converter that returns a JSON stream
- |
-
class |
-XMLTabularDataConverter
-A data converter that returns an XML Stream
- |
-
class |
-XSLXTabularDataConverter
-A data converter that returns a XSLX Stream
- |
-
| Class and Description | -
|---|
| ResultDataConverter
- A base interface that is implemented to create a set of data converters for output from the IRCT format
- |
-
public class IRCTEventListener
+extends java.lang.Object
+| Constructor and Description | +
|---|
IRCTEventListener() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+afterAction(SecureSession session,
+ Action action)
+Runs the event listeners after an action is run
+ |
+
void |
+afterExecutionPlan(SecureSession session,
+ Executable executable)
+Runs the event listeners after an execution plan is run
+ |
+
void |
+afterFind(java.util.List<Entity> matches,
+ FindInformationInterface findInformation,
+ SecureSession session)
+Runs the listeners after a find is executed
+ |
+
void |
+afterGetResult(Result result)
+Runs the event listeners after a result is retrieved
+ |
+
void |
+afterJoin(SecureSession session,
+ IRCTJoin joinType)
+Runs the event listeners after a join is run
+ |
+
void |
+afterProcess(SecureSession session,
+ IRCTProcess process)
+Runs the event listeners after a process is run
+ |
+
void |
+afterQuery(SecureSession session,
+ Resource resource,
+ Query query)
+Runs the event listeners after a query is run
+ |
+
void |
+afterSaveResult(Result result)
+Runs the event listers after a result is saved
+ |
+
void |
+afterVisualization() |
+
void |
+beforeAction(SecureSession session,
+ Action action)
+Runs the event listeners before an action is run
+ |
+
void |
+beforeExecutionPlan(SecureSession session,
+ Executable executable)
+Runs the event listener before an execution plan is run
+ |
+
void |
+beforeFind(Resource resource,
+ Entity resourcePath,
+ java.util.List<FindInformationInterface> findInformation,
+ SecureSession session)
+Runs the event listeners before a find is executed
+ |
+
void |
+beforeGetResult(User user,
+ java.lang.Long resultId)
+Runs the event listeners before a result is retrieved
+ |
+
void |
+beforeJoin(SecureSession session,
+ IRCTJoin joinType)
+Runs the event listeners before a join is run
+ |
+
void |
+beforeProcess(SecureSession session,
+ IRCTProcess process)
+Runs the event listeners before a process is run
+ |
+
void |
+beforeQuery(SecureSession session,
+ Resource resource,
+ Query query)
+Runs the event listeners before a query is run
+ |
+
void |
+beforeSaveResult(Result result)
+Runs the event listers before a result is saved
+ |
+
void |
+beforeVisualization() |
+
void |
+init()
+Initiates the even listener
+ |
+
void |
+registerListener(EventConverterImplementation eci)
+Registers a new event listener
+ |
+
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void init()+
public void registerListener(EventConverterImplementation eci)+
irctEvent - Listenerpublic void afterAction(SecureSession session, + Action action)+
session - Sessionaction - Actionpublic void afterExecutionPlan(SecureSession session, + Executable executable)+
session - Sessionexecutable - Execution Planpublic void afterJoin(SecureSession session, + IRCTJoin joinType)+
session - SessionjoinType - Type of Joinpublic void afterProcess(SecureSession session, + IRCTProcess process)+
session - Sessionprocess - Processpublic void afterQuery(SecureSession session, + Resource resource, + Query query)+
session - Sessionresource - Resourcequery - Querypublic void afterVisualization()+
public void beforeAction(SecureSession session, + Action action)+
session - Sessionaction - Actionpublic void beforeExecutionPlan(SecureSession session, + Executable executable)+
session - Sessionexecutable - Execution Planpublic void beforeJoin(SecureSession session, + IRCTJoin joinType)+
session - SessionjoinType - Joinpublic void beforeProcess(SecureSession session, + IRCTProcess process)+
session - Sessionprocess - Processpublic void beforeQuery(SecureSession session, + Resource resource, + Query query)+
session - Sessionresource - Resourcequery - Querypublic void beforeVisualization()+
public void afterGetResult(Result result)+
result - Resultpublic void afterSaveResult(Result result)+
result - Resultpublic void beforeGetResult(User user, + java.lang.Long resultId)+
user - UserresultId - Resultpublic void beforeSaveResult(Result result)+
result - Resultpublic void beforeFind(Resource resource, + Entity resourcePath, + java.util.List<FindInformationInterface> findInformation, + SecureSession session)+
resource - ResourceresourcePath - Path on the resourcefindInformation - Information for the findsession - Session Informationpublic void afterFind(java.util.List<Entity> matches, + FindInformationInterface findInformation, + SecureSession session)+
returns - A list of entitiesfindInformation - Information for the findsession - Session Information| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ Executable executable)
+An action that is run after an execution plan is completed
+ |
+
void fire(SecureSession session, + Executable executable)+
session - Sessionexecutable - Executable| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ IRCTJoin joinType) |
+
void fire(SecureSession session, + IRCTJoin joinType)+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ IRCTProcess process) |
+
void fire(SecureSession session, + IRCTProcess process)+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ Resource resource,
+ Query query) |
+
void fire(SecureSession session, + Resource resource, + Query query)+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ Action action) |
+
void fire(SecureSession session, + Action action)+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ Executable executable) |
+
void fire(SecureSession session, + Executable executable)+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ IRCTJoin joinType) |
+
void fire(SecureSession session, + IRCTJoin joinType)+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ IRCTProcess process) |
+
void fire(SecureSession session, + IRCTProcess process)+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(SecureSession session,
+ Resource resource,
+ Query query) |
+
void fire(SecureSession session, + Resource resource, + Query query)+
| Package | +Description | +
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.event | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.event.action | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.event.find | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.event.result | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
IRCTEvent |
+EventConverterImplementation.getEventListener()
+Returns the IRCT Event Converter Implementation
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+EventConverterImplementation.setEventListener(IRCTEvent eventListener)
+Sets the IRCT Event Converter Implementation
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AfterAction
+An event listener that is run after an action is run
+ |
+
interface |
+AfterExecutionPlan
+An event listener that is run after an execution plan is run
+ |
+
interface |
+AfterJoin
+An event listener that is run after a join is run
+ |
+
interface |
+AfterProcess
+An event listener that is run after a process is run
+ |
+
interface |
+AfterQuery
+An event listener that is run after a query is run
+ |
+
interface |
+AfterVisualization
+An event listener that is run after a result a visualization is created
+ |
+
interface |
+BeforeAction
+An event listener that is run before an action is run
+ |
+
interface |
+BeforeExecutionPlan
+An event listener that is run before an execution plan is run
+ |
+
interface |
+BeforeJoin
+An event listener that is run before a join is run
+ |
+
interface |
+BeforeProcess
+An event listener that is run before a process is run
+ |
+
interface |
+BeforeQuery
+An event listener that is run before a query is run
+ |
+
interface |
+BeforeVisualization
+An event listener that is run before a visualization
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AfterFind
+An event listener that is run after a find is executed
+ |
+
interface |
+BeforeFind
+An event listener that is run before a find is executed
+ |
+
| Modifier and Type | +Interface and Description | +
|---|---|
interface |
+AfterGetResult
+An event listener that is run after a result is retrieved
+ |
+
interface |
+AfterSaveResult
+An event listener that is run after a result is retrieved
+ |
+
interface |
+BeforeGetResult
+An event listener that is run before a result is retrieved
+ |
+
interface |
+BeforeSaveResult
+An event listener that is run before a result is retrieved
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
IRCTEvent |
+IRCTEventImplementationConverter.convertToEntityAttribute(java.lang.String className) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.String |
+IRCTEventImplementationConverter.convertToDatabaseColumn(IRCTEvent resultDataConverter) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(java.util.List<Entity> matches,
+ FindInformationInterface findInformation,
+ SecureSession session) |
+
void fire(java.util.List<Entity> matches, + FindInformationInterface findInformation, + SecureSession session)+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(Resource resource,
+ Entity resourcePath,
+ java.util.List<FindInformationInterface> findInformation,
+ SecureSession session) |
+
void fire(Resource resource, + Entity resourcePath, + java.util.List<FindInformationInterface> findInformation, + SecureSession session)+
| Package | +Description | +
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.event | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.event.action | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.event.find | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.event.result | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.util | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | ++ |
| Class and Description | +
|---|
| EventConverterImplementation
+ A representation of a IRCT Event Listener
+ |
+
| IRCTEvent
+ The IRCT event listener base that other event listeners extend.
+ |
+
| Class and Description | +
|---|
| IRCTEvent
+ The IRCT event listener base that other event listeners extend.
+ |
+
| Class and Description | +
|---|
| IRCTEvent
+ The IRCT event listener base that other event listeners extend.
+ |
+
| Class and Description | +
|---|
| IRCTEvent
+ The IRCT event listener base that other event listeners extend.
+ |
+
| Class and Description | +
|---|
| IRCTEventListener
+ Manages the event listeners
+ |
+
| Class and Description | +
|---|
| IRCTEvent
+ The IRCT event listener base that other event listeners extend.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(Result result)
+An action that is run after a result is retrieved
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(User user,
+ java.lang.Long resultId) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+fire(Result result) |
+
public class ClauseIsNotTheCorrectType
-extends java.lang.Exception
-| Constructor and Description | -
|---|
ClauseIsNotTheCorrectType(java.lang.Long clauseId)
-Constructs an exception with information about clause id
- |
-
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringequals, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic class ClauseNotFoundException
-extends java.lang.Exception
-| Constructor and Description | -
|---|
ClauseNotFoundException(java.lang.Long clauseId)
-Creates an exception indicating that the clause could not be found
- |
-
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringequals, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic class JoinTypeNotSupported
-extends java.lang.Exception
-| Constructor and Description | -
|---|
JoinTypeNotSupported(java.lang.String joinType)
-Creates an exception indicating that the join type is not supported
- |
-
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringequals, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic class LogicalOperatorNotFound
-extends java.lang.Exception
-| Constructor and Description | -
|---|
LogicalOperatorNotFound(java.lang.String logicalOperator)
-Creates an exception indicating that the logical operator was not found
- |
-
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringequals, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic class PredicateException
-extends java.lang.Exception
-| Constructor and Description | -
|---|
PredicateException(java.lang.String message)
-Create an exception that an unspecified error occurred in the predicate.
- |
-
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringequals, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic class PredicateTypeNotSupported
-extends java.lang.Exception
-| Constructor and Description | -
|---|
PredicateTypeNotSupported(java.lang.String predicate)
-Creates a predicate type is not supported exception
- |
-
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringequals, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic class ResourceNotFoundException
-extends java.lang.Exception
-| Constructor and Description | -
|---|
ResourceNotFoundException(java.lang.String resource)
-Creates an exception that the resource was not found
- |
-
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringequals, getClass, hashCode, notify, notifyAll, wait, wait, waitpublic class SubQueryNotFoundException
-extends java.lang.Exception
-| Constructor and Description | -
|---|
SubQueryNotFoundException(java.lang.Long sqId)
-Creates an exception that states that the subquery was not found
- |
-
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toStringequals, getClass, hashCode, notify, notifyAll, wait, wait, waitvoidaddJoinClause()
+java.lang.LongaddJoinClause(java.lang.Long clauseId,
+ Resource resource,
+ JoinType joinType,
+ java.util.Map<java.lang.String,java.lang.String> joinFields)
java.util.List<Entity>searchForOntology(Resource resource,
- Entity resourcePath,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-java.util.List<Entity>searchForTerm(Resource resource,
+PathController.searchForTerm(Resource resource,
Entity resourcePath,
- java.lang.String searchTerm,
+ FindInformationInterface findInformation,
SecureSession session)
Searches a resource for a given searchTerm.
java.util.List<Entity>traversePath(Resource resource,
Entity resourcePath,
@@ -262,27 +252,35 @@ Uses of
java.util.List<Entity>PathResourceImplementationInterface.find(Entity path,
+ FindInformationInterface findInformation,
+ SecureSession session)
+Given a path find all entities that match the finds
+
+
java.util.List<Entity>getPathRelationship(Entity path,
OntologyRelationship relationship,
SecureSession session)
ResultgetResults(SecureSession session,
Result result)
ResultgetResults(SecureSession session,
Result result)
ResultrunProcess(SecureSession session,
IRCTProcess process,
@@ -290,7 +288,7 @@ Uses of Run the given process
ResultrunQuery(SecureSession session,
Query qep,
@@ -298,25 +296,7 @@ Uses of Runs the given query
java.util.List<Entity>searchOntology(Entity path,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-java.util.List<Entity>searchPaths(Entity path,
- java.lang.String searchTerm,
- SecureSession session)
-voidsetup(java.util.Map<java.lang.String,java.lang.String> parameters)
| Modifier and Type | +Method and Description | +
|---|---|
void |
+IRCTEventListener.afterExecutionPlan(SecureSession session,
+ Executable executable)
+Runs the event listeners after an execution plan is run
+ |
+
void |
+IRCTEventListener.beforeExecutionPlan(SecureSession session,
+ Executable executable)
+Runs the event listener before an execution plan is run
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+BeforeExecutionPlan.fire(SecureSession session,
+ Executable executable) |
+
void |
+AfterExecutionPlan.fire(SecureSession session,
+ Executable executable)
+An action that is run after an execution plan is completed
+ |
+
| Class and Description | +
|---|
| Executable
+ The executable interface provides a set of methods that an executable must
+ implement.
+ |
+
| Class and Description | +
|---|
| Executable
+ The executable interface provides a set of methods that an executable must
+ implement.
+ |
+
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.resource | -- |
| Modifier and Type | -Method and Description | -
|---|---|
ActionState |
-ProcessResourceImplementationInterface.runProcess(IRCTProcess pep)
-Run the given process
- |
-
ActionState |
-QueryResourceImplementationInterface.runQuery(Query qep)
-Runs the given query
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-QueryResourceImplementationInterface.getResults(ActionState actionState)
-Returns the results of the query if they are available
- |
-
ResultSet |
-ProcessResourceImplementationInterface.getResults(ActionState actionState)
-Returns the results of the process if they are available
- |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.resource | -- |
| Class and Description | -
|---|
| ActionState
- An object used to keep track of an action
- |
-
| Package | +Description | +
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.controller | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.event | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.event.find | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.model.find | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.model.resource.implementation | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<Entity> |
+PathController.searchForTerm(Resource resource,
+ Entity resourcePath,
+ FindInformationInterface findInformation,
+ SecureSession session)
+Searches a resource for a given searchTerm.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+IRCTEventListener.afterFind(java.util.List<Entity> matches,
+ FindInformationInterface findInformation,
+ SecureSession session)
+Runs the listeners after a find is executed
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+IRCTEventListener.beforeFind(Resource resource,
+ Entity resourcePath,
+ java.util.List<FindInformationInterface> findInformation,
+ SecureSession session)
+Runs the event listeners before a find is executed
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+AfterFind.fire(java.util.List<Entity> matches,
+ FindInformationInterface findInformation,
+ SecureSession session) |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+BeforeFind.fire(Resource resource,
+ Entity resourcePath,
+ java.util.List<FindInformationInterface> findInformation,
+ SecureSession session) |
+
| Modifier and Type | +Class and Description | +
|---|---|
class |
+FindByOntology |
+
class |
+FindByPath |
+
| Modifier and Type | +Method and Description | +
|---|---|
<T extends FindInformationInterface> |
+FindInformationInterface.copy() |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<Entity> |
+PathResourceImplementationInterface.find(Entity path,
+ FindInformationInterface findInformation,
+ SecureSession session)
+Given a path find all entities that match the finds
+ |
+
| Modifier and Type | Method and Description | ||
|---|---|---|---|
java.util.List<IRCTJoin> |
-Resource.getSupportedJoins()
-Returns a list joins that are supported by the resource
+ | void |
+IRCTEventListener.afterJoin(SecureSession session,
+ IRCTJoin joinType)
+Runs the event listeners after a join is run
+ |
+
void |
+IRCTEventListener.beforeJoin(SecureSession session,
+ IRCTJoin joinType)
+Runs the event listeners before a join is run
|
| Modifier and Type | Method and Description | @@ -247,9 +264,13 @@void |
-Resource.setSupportedJoins(java.util.List<IRCTJoin> supportedJoins)
-Sets the list joins that are supported by the resource
- |
+BeforeJoin.fire(SecureSession session,
+ IRCTJoin joinType) |
+
|---|---|---|---|---|
void |
+AfterJoin.fire(SecureSession session,
+ IRCTJoin joinType) |
| Class and Description | +
|---|
| IRCTJoin
+ The join type class provides a way for the IRCT application to keep track of
+ which joins can be used.
+ |
+
| Class and Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| IRCTJoin + | IRCTJoin
The join type class provides a way for the IRCT application to keep track of
which joins can be used.
|
diff --git a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/DataType.html b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/DataType.html
index ddd886e..51d4467 100644
--- a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/DataType.html
+++ b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/DataType.html
@@ -2,9 +2,9 @@
-
+
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.lang.Long |
+getId() |
+|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.lang.String |
getName()
Returns the entity name
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.lang.String |
getOntology()
Returns the entity ontology
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.lang.String |
getOntologyId()
Returns the entity ontology term id
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.lang.String |
getPui()
Returns the Path Unique Identifier
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<OntologyRelationship> |
getRelationships()
Returns a list of relationships this entity has
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)
Sets a map of additional attributes of the entity
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setCounts(java.util.Map<java.lang.String,java.lang.Integer> counts)
Sets a map of the counts associated with this entity
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setDataType(DataType dataType)
Sets the data type of the entity
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setDescription(java.lang.String description)
Sets the entity description
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setDisplayName(java.lang.String displayName)
Sets the display name
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
+setId(java.lang.Long id) |
+|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setName(java.lang.String name)
Sets the entity name
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setOntology(java.lang.String ontology)
Sets the entity ontology
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setOntologyId(java.lang.String ontologyId)
Sets the entity ontology term id
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setPui(java.lang.String pui)
Sets the Path Unique Identifier
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
void |
setRelationships(java.util.List<OntologyRelationship> relationships)
Sets the list of relationships this entity has
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
javax.json.JsonObject |
toJson()
Returns a JSONObject representation of the object.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
javax.json.JsonObject |
toJson(int depth)
Returns a JSONObject representation of the object.
@@ -380,6 +388,32 @@ toJson+ + + +
-
-edu.harvard.hms.dbmi.bd2k.irct.model.ontology
-Class Path-
-
-
-
-
-
-
-
-
diff --git a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/PrimitiveDataType.html b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/PrimitiveDataType.html
deleted file mode 100644
index a7cdf32..0000000
--- a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/PrimitiveDataType.html
+++ /dev/null
@@ -1,453 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-edu.harvard.hms.dbmi.bd2k.irct.model.ontology
-Enum PrimitiveDataType-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/class-use/DataType.html b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/class-use/DataType.html
index 209bed4..7b46388 100644
--- a/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/class-use/DataType.html
+++ b/javadoc/edu/harvard/hms/dbmi/bd2k/irct/model/ontology/class-use/DataType.html
@@ -2,9 +2,9 @@
-
+
-
-
-
-
-
-
-
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| edu.harvard.hms.dbmi.bd2k.irct.event | ++ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| edu.harvard.hms.dbmi.bd2k.irct.event.find | ++ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| edu.harvard.hms.dbmi.bd2k.irct.model.query | java.util.List<Entity> |
-PathController.searchForOntology(Resource resource,
- Entity resourcePath,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-Searches a resource for a given ontology term from a given ontology.
- |
-
-||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<Entity> |
-PathController.searchForTerm(Resource resource,
+ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<Entity> |
PathController.traversePath(Resource resource,
Entity resourcePath,
@@ -176,24 +174,14 @@ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<Entity> |
-PathController.searchForTerm(Resource resource,
+ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<Entity> |
PathController.traversePath(Resource resource,
Entity resourcePath,
@@ -205,6 +193,82 @@ | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<Entity> |
-PathResourceImplementationInterface.searchOntology(Entity path,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-Given a given path find all the ontology terms of the given ontology type
- that are in that path.
- |
-|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<Entity> |
-PathResourceImplementationInterface.searchPaths(Entity path,
- java.lang.String searchTerm,
- SecureSession session)
-Given a given path find all the searchTerms that are in that path.
+ | PathResourceImplementationInterface.getPathRelationship(Entity path,
+ OntologyRelationship relationship,
+ SecureSession session)
+Given a path give all the associated paths of that type of relationship
|
java.util.List<Entity> |
-PathResourceImplementationInterface.getPathRelationship(Entity path,
- OntologyRelationship relationship,
- SecureSession session)
-Given a path give all the associated paths of that type of relationship
+ | PathResourceImplementationInterface.find(Entity path,
+ FindInformationInterface findInformation,
+ SecureSession session)
+Given a path find all entities that match the finds
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<Entity> |
-PathResourceImplementationInterface.searchOntology(Entity path,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-Given a given path find all the ontology terms of the given ontology type
- that are in that path.
- |
-|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
java.util.List<Entity> |
-PathResourceImplementationInterface.searchPaths(Entity path,
- java.lang.String searchTerm,
- SecureSession session)
-Given a given path find all the searchTerms that are in that path.
+ | PathResourceImplementationInterface.getPathRelationship(Entity path,
+ OntologyRelationship relationship,
+ SecureSession session)
+Given a path give all the associated paths of that type of relationship
|
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.controller | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.ontology | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.query | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.resource | -- |
| edu.harvard.hms.dbmi.bd2k.irct.util | -- |
| Modifier and Type | -Method and Description | -
|---|---|
Path |
-PathController.getPathFromString(Resource resource,
- java.lang.String path)
-Returns the path given the string
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<Path> |
-PathController.getPathRelationship(Resource resource,
- Path path,
- OntologyRelationship relationship)
-Gets the paths of the relationship with a given path on a specific resource
- |
-
java.util.List<Path> |
-PathController.getPathRoot(Resource resource)
-Returns the root of the resource
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.Long |
-QueryController.addJoinClause(java.lang.Long sqId1,
- java.lang.Long sqId2,
- java.lang.String joinType,
- Path fieldId1,
- Path fieldId2,
- java.lang.String relationship,
- java.lang.Long joinId)
-Adds a join clause between to different subqueries
-
- NOTE: NOT CURRENTLY TESTED OR FULLY IMPEMENTED
- |
-
java.lang.Long |
-QueryController.addSelectClause(java.lang.Long sqId,
- Path parameter,
- Resource resource)
-Adds a select clause to a subQuery
- |
-
java.lang.Long |
-QueryController.addWhereClause(java.lang.Long sqId,
- java.lang.String logicalOperator,
- Path field,
- java.lang.String predicateName,
- java.util.Map<java.lang.String,java.lang.String> values,
- java.lang.Long whereId,
- Resource resource)
-Adds a where clause to a given query or subquery
- |
-
java.util.List<Path> |
-PathController.getPathRelationship(Resource resource,
- Path path,
- OntologyRelationship relationship)
-Gets the paths of the relationship with a given path on a specific resource
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.Map<OntologyRelationship,java.util.List<Path>> |
-Path.getRelationships()
-Returns a map of the relationships where the key is relationship type,
- and the value is a list of paths
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-Path.setRelationships(java.util.Map<OntologyRelationship,java.util.List<Path>> relationships)
-Sets the relationship map where the key is the relationship type, and the
- value is a list of paths.
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
Path |
-WhereClause.getField()
-Returns the path that is associated with the where clause
- |
-
Path |
-JoinClause.getField1()
-Returns the first field if it exists
- |
-
Path |
-JoinClause.getField2()
-Returns the second field if it exists
- |
-
Path |
-SelectClause.getParameter()
-Returns the parameters for the select clause
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-WhereClause.setField(Path field)
-Sets the path that is associated with the where clause
- |
-
void |
-JoinClause.setField1(Path field1)
-Sets the first field
- |
-
void |
-JoinClause.setField2(Path field2)
-Sets the second field
- |
-
void |
-SelectClause.setParameters(Path parameter)
-Sets the parameters for the select clause
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
Path |
-PathResourceImplementationInterface.getPathFromString(java.lang.String path)
-Turns a string into a path
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<Path> |
-PathResourceImplementationInterface.getPathRelationship(Path path,
- OntologyRelationship relationship)
-Given a path give all the associated paths of that type of relationship
- |
-
java.util.List<Path> |
-PathResourceImplementationInterface.getPathRoot()
-Get the root of the resource
- |
-
java.util.List<Path> |
-ResourceImplementationInterface.getReturnEntity()
-Returns a path representation of the default object that is returned
- |
-
java.util.List<Path> |
-QueryResourceImplementationInterface.getReturnEntity()
-Returns the the default entity that is returned with a query
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<Path> |
-PathResourceImplementationInterface.getPathRelationship(Path path,
- OntologyRelationship relationship)
-Given a path give all the associated paths of that type of relationship
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
static Path |
-Utilities.traversePath(Path currentPosition,
- java.lang.String[] components)
-Traverses the paths
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
static Path |
-Utilities.traversePath(Path currentPosition,
- java.lang.String[] components)
-Traverses the paths
- |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.ontology | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.query | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.result | -- |
| Modifier and Type | -Method and Description | -
|---|---|
static PrimitiveDataType |
-PrimitiveDataType.valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static PrimitiveDataType[] |
-PrimitiveDataType.values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<PrimitiveDataType> |
-JoinType.getSupportedDataTypes()
-Returns a list of supported data types
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
boolean |
-PredicateTypeValue.supportsDataType(PrimitiveDataType dataType)
-Returns if the predicate supports a given Data Type
- |
-
boolean |
-PredicateType.supportsDataType(PrimitiveDataType dataType)
-Returns if the predicate supports a given Data Type
- |
-
boolean |
-JoinType.supportsDataType(PrimitiveDataType dataType)
-Returns if the join type supports a given data type
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-JoinType.setSupportedDataTypes(java.util.List<PrimitiveDataType> supportedDataTypes)
-Sets the list of supported data types
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
PrimitiveDataType |
-Column.getDataType()
-Returns the Data Type of the column
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-Column.setDataType(PrimitiveDataType dataType)
-Sets the Data Type of the column
- |
-
| Class and Description | +
|---|
| Entity
+ The Entity class represents a path, and object in a resource.
+ |
+
| Class and Description | +
|---|
| Entity
+ The Entity class represents a path, and object in a resource.
+ |
+
java.lang.StringtoString() public java.lang.String toString()+
toString in class java.lang.Objectpublic enum IRCTProcessParameterType -extends java.lang.Enum<IRCTProcessParameterType>-
| Enum Constant and Description | -
|---|
BOOLEAN |
-
BYTE |
-
DATE |
-
DATETIME |
-
DOUBLE |
-
FLOAT |
-
INTEGER |
-
LONG |
-
RESULTSET |
-
RESULTSETFIELD |
-
STRING |
-
TIME |
-
| Modifier and Type | -Method and Description | -
|---|---|
static IRCTProcessParameterType |
-valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static IRCTProcessParameterType[] |
-values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOfgetClass, notify, notifyAll, wait, wait, waitpublic static final IRCTProcessParameterType BOOLEAN-
public static final IRCTProcessParameterType BYTE-
public static final IRCTProcessParameterType DOUBLE-
public static final IRCTProcessParameterType FLOAT-
public static final IRCTProcessParameterType INTEGER-
public static final IRCTProcessParameterType LONG-
public static final IRCTProcessParameterType STRING-
public static final IRCTProcessParameterType DATE-
public static final IRCTProcessParameterType DATETIME-
public static final IRCTProcessParameterType TIME-
public static final IRCTProcessParameterType RESULTSET-
public static final IRCTProcessParameterType RESULTSETFIELD-
public static IRCTProcessParameterType[] values()-
-for (IRCTProcessParameterType c : IRCTProcessParameterType.values()) - System.out.println(c); -
public static IRCTProcessParameterType 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 namejava.lang.NullPointerException - if the argument is null@Entity
-public class ProcessType
-extends java.lang.Object
-implements java.io.Serializable
-| Constructor and Description | -
|---|
ProcessType() |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-getDescription()
-Returns a description of the process
- |
-
java.lang.String |
-getDisplayName() |
-
long |
-getId()
-Returns the id
- |
-
java.lang.String |
-getName()
-Returns the name of the process
- |
-
java.util.List<ProcessTypeParameter> |
-getParameter()
-Returns a list parameters
- |
-
void |
-setDescription(java.lang.String description)
-Sets the description of the process
- |
-
void |
-setDisplayName(java.lang.String displayName) |
-
void |
-setId(long id)
-Sets the id
- |
-
void |
-setName(java.lang.String name)
-Sets the name of the process
- |
-
void |
-setParameter(java.util.List<ProcessTypeParameter> parameter)
-Sets a list of the parameters
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic javax.json.JsonObject toJson()-
public javax.json.JsonObject toJson(int depth)-
depth - Depth to travelpublic long getId()-
public void setId(long id)-
id - IDpublic java.lang.String getName()-
public void setName(java.lang.String name)-
name - Namepublic java.lang.String getDescription()-
public void setDescription(java.lang.String description)-
description - Descriptionpublic java.util.List<ProcessTypeParameter> getParameter()-
public void setParameter(java.util.List<ProcessTypeParameter> parameter)-
parameter - List of the parameterspublic java.lang.String getDisplayName()-
public void setDisplayName(java.lang.String displayName)-
displayName - the displayName to set@Entity
-public class ProcessTypeParameter
-extends java.lang.Object
-implements java.io.Serializable
-| Constructor and Description | -
|---|
ProcessTypeParameter() |
-
| Modifier and Type | -Method and Description | -
|---|---|
long |
-getId()
-Returns the id
- |
-
java.lang.String |
-getName()
-Returns the name of the parameter
- |
-
ProcessTypeParameterType |
-getType()
-Returns the IRCT Parameter Type
- |
-
java.lang.String |
-getValue()
-Returns the value of the parameter
- |
-
void |
-setId(long id)
-Sets the id
- |
-
void |
-setName(java.lang.String name)
-Sets the name of the parameter
- |
-
void |
-setType(ProcessTypeParameterType type)
-Sets the IRCT Parameter Type
- |
-
void |
-setValue(java.lang.String value)
-Sets the value of the parameter
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic javax.json.JsonObject toJson()-
public javax.json.JsonObject toJson(int depth)-
depth - Depth to travelpublic long getId()-
public void setId(long id)-
id - IDpublic java.lang.String getName()-
public void setName(java.lang.String name)-
name - Namepublic ProcessTypeParameterType getType()-
public void setType(ProcessTypeParameterType type)-
type - Parameter Typepublic java.lang.String getValue()-
public void setValue(java.lang.String value)-
value - Valuepublic enum ProcessTypeParameterType -extends java.lang.Enum<ProcessTypeParameterType>-
| Enum Constant and Description | -
|---|
BOOLEAN |
-
BYTE |
-
DATE |
-
DATETIME |
-
DOUBLE |
-
FLOAT |
-
INTEGER |
-
LONG |
-
RESULTSET |
-
RESULTSETFIELD |
-
STRING |
-
TIME |
-
| Modifier and Type | -Method and Description | -
|---|---|
static ProcessTypeParameterType |
-valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static ProcessTypeParameterType[] |
-values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOfgetClass, notify, notifyAll, wait, wait, waitpublic static final ProcessTypeParameterType BOOLEAN-
public static final ProcessTypeParameterType BYTE-
public static final ProcessTypeParameterType DOUBLE-
public static final ProcessTypeParameterType FLOAT-
public static final ProcessTypeParameterType INTEGER-
public static final ProcessTypeParameterType LONG-
public static final ProcessTypeParameterType STRING-
public static final ProcessTypeParameterType DATE-
public static final ProcessTypeParameterType DATETIME-
public static final ProcessTypeParameterType TIME-
public static final ProcessTypeParameterType RESULTSET-
public static final ProcessTypeParameterType RESULTSETFIELD-
public static ProcessTypeParameterType[] values()-
-for (ProcessTypeParameterType c : ProcessTypeParameterType.values()) - System.out.println(c); -
public static ProcessTypeParameterType 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 namejava.lang.NullPointerException - if the argument is null| Modifier and Type | +Method and Description | +
|---|---|
void |
+IRCTEventListener.afterProcess(SecureSession session,
+ IRCTProcess process)
+Runs the event listeners after a process is run
+ |
+
void |
+IRCTEventListener.beforeProcess(SecureSession session,
+ IRCTProcess process)
+Runs the event listeners before a process is run
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+BeforeProcess.fire(SecureSession session,
+ IRCTProcess process) |
+
void |
+AfterProcess.fire(SecureSession session,
+ IRCTProcess process) |
+
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.process | -- |
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<IRCTProcessParameter> |
-IRCTProcess.getParameter()
-Returns a list parameters
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-IRCTProcess.setParameter(java.util.List<IRCTProcessParameter> parameter)
-Sets a list of the parameters
- |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.process | -- |
| Modifier and Type | -Method and Description | -
|---|---|
IRCTProcessParameterType |
-IRCTProcessParameter.getType()
-Returns the IRCT Parameter Type
- |
-
static IRCTProcessParameterType |
-IRCTProcessParameterType.valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static IRCTProcessParameterType[] |
-IRCTProcessParameterType.values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-IRCTProcessParameter.setType(IRCTProcessParameterType type)
-Sets the IRCT Parameter Type
- |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.process | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.resource | -- |
| Modifier and Type | -Method and Description | -
|---|---|
ProcessType |
-IRCTProcess.getProcessType() |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-IRCTProcess.setProcessType(ProcessType processType) |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<ProcessType> |
-Resource.getAvailableProcesses() |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-Resource.setAvailableProcesses(java.util.List<ProcessType> availableProcesses) |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.process | -- |
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<ProcessTypeParameter> |
-ProcessType.getParameter()
-Returns a list parameters
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-ProcessType.setParameter(java.util.List<ProcessTypeParameter> parameter)
-Sets a list of the parameters
- |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.process | -- |
| Modifier and Type | -Method and Description | -
|---|---|
ProcessTypeParameterType |
-ProcessTypeParameter.getType()
-Returns the IRCT Parameter Type
- |
-
static ProcessTypeParameterType |
-ProcessTypeParameterType.valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static ProcessTypeParameterType[] |
-ProcessTypeParameterType.values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-ProcessTypeParameter.setType(ProcessTypeParameterType type)
-Sets the IRCT Parameter Type
- |
-
| Class and Description | +
|---|
| IRCTProcess
+ Creates an executable process
+ |
+
| Class and Description | +
|---|
| IRCTProcess
+ Creates an executable process
+ |
+
JoinTypegetJoinType() java.util.Map<java.lang.String,java.lang.String>getStringValues()
voidsetJoinType(JoinType joinType) voidsetStringValues(java.util.Map<java.lang.String,java.lang.String> stringValues)
public JoinType getJoinType()+
public void setJoinType(JoinType joinType)+
joinType - the joinType to setpublic class JoinType
+@Entity
+public class JoinType
extends java.lang.Object
implements java.io.Serializable
public enum LogicalOperator -extends java.lang.Enum<LogicalOperator>-
| Enum Constant and Description | -
|---|
AND |
-
NOT |
-
OR |
-
| Modifier and Type | -Method and Description | -
|---|---|
static LogicalOperator |
-valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static LogicalOperator[] |
-values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOfgetClass, notify, notifyAll, wait, wait, waitpublic static final LogicalOperator AND-
public static final LogicalOperator OR-
public static final LogicalOperator NOT-
public static LogicalOperator[] values()-
-for (LogicalOperator c : LogicalOperator.values()) - System.out.println(c); -
public static LogicalOperator 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 namejava.lang.NullPointerException - if the argument is null@Entity
-public class PredicateTypeValue
-extends java.lang.Object
-implements java.io.Serializable
-| Constructor and Description | -
|---|
PredicateTypeValue() |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-getField() |
-
long |
-getId()
-Returns the id
- |
-
java.lang.String |
-getName() |
-
java.util.List<java.lang.String> |
-getPermittedValues()
-Returns a list of permitted values if they are limited
- |
-
java.lang.String |
-getRelationship() |
-
java.util.List<PredicateTypeValueDataType> |
-getSupportedDataTypes()
-Returns a list of supported predicate types
- |
-
boolean |
-isRequired()
-Returns if this value is required
- |
-
void |
-setField(java.lang.String field) |
-
void |
-setId(long id)
-Sets the id
- |
-
void |
-setName(java.lang.String name) |
-
void |
-setPermittedValues(java.util.List<java.lang.String> permittedValues)
-Sets a list of permitted values if they are limited
- |
-
void |
-setRelationship(java.lang.String relationship) |
-
void |
-setRequired(boolean required)
-Sets if this value is required
- |
-
void |
-setSupportedDataTypes(java.util.List<PredicateTypeValueDataType> supportedDataTypes)
-Sets the supported predicate types
- |
-
boolean |
-supportsDataType(PrimitiveDataType dataType)
-Returns if the predicate supports a given Data Type
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic boolean supportsDataType(PrimitiveDataType dataType)-
dataType - The Data Typepublic javax.json.JsonObject toJson()-
public javax.json.JsonObject toJson(int depth)-
depth - Depth to travelpublic long getId()-
public void setId(long id)-
id - Idpublic java.lang.String getName()-
public void setName(java.lang.String name)-
name - the name to setpublic java.lang.String getField()-
public void setField(java.lang.String field)-
field - the field to setpublic boolean isRequired()-
public void setRequired(boolean required)-
required - Requiredpublic java.util.List<PredicateTypeValueDataType> getSupportedDataTypes()-
public void setSupportedDataTypes(java.util.List<PredicateTypeValueDataType> supportedDataTypes)-
supportedDataTypes - Supported predicate typespublic java.util.List<java.lang.String> getPermittedValues()-
public void setPermittedValues(java.util.List<java.lang.String> permittedValues)-
permittedValues - Permitted valuespublic java.lang.String getRelationship()-
public void setRelationship(java.lang.String relationship)-
relationship - the relationship to setpublic enum PredicateTypeValueDataType -extends java.lang.Enum<PredicateTypeValueDataType>-
| Enum Constant and Description | -
|---|
BOOLEAN |
-
BYTE |
-
DATE |
-
DATETIME |
-
DOUBLE |
-
FLOAT |
-
INTEGER |
-
LONG |
-
PATH |
-
RESULTSET |
-
STRING |
-
TIME |
-
| Modifier and Type | -Method and Description | -
|---|---|
static PredicateTypeValueDataType |
-valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static PredicateTypeValueDataType[] |
-values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOfgetClass, notify, notifyAll, wait, wait, waitpublic static final PredicateTypeValueDataType BOOLEAN-
public static final PredicateTypeValueDataType BYTE-
public static final PredicateTypeValueDataType DOUBLE-
public static final PredicateTypeValueDataType FLOAT-
public static final PredicateTypeValueDataType INTEGER-
public static final PredicateTypeValueDataType LONG-
public static final PredicateTypeValueDataType STRING-
public static final PredicateTypeValueDataType DATE-
public static final PredicateTypeValueDataType DATETIME-
public static final PredicateTypeValueDataType TIME-
public static final PredicateTypeValueDataType PATH-
public static final PredicateTypeValueDataType RESULTSET-
public static PredicateTypeValueDataType[] values()-
-for (PredicateTypeValueDataType c : PredicateTypeValueDataType.values()) - System.out.println(c); -
public static PredicateTypeValueDataType 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 namejava.lang.NullPointerException - if the argument is nulljava.util.List<Resource>java.util.Set<Resource>getResources()
voidsetResources(java.util.List<Resource> resources)
+setResources(java.util.Set<Resource> resources)
java.lang.StringtoString()
+public java.lang.String toString()+
toString in class java.lang.Objectpublic java.util.List<Resource> getResources()+
public java.util.Set<Resource> getResources()
public void setResources(java.util.List<Resource> resources)+
public void setResources(java.util.Set<Resource> resources)
addClause, addResource, addSubQuery, getClauses, getId, getName, getResources, getSubQueries, removeClause, removeResource, removeSubQuery, setClauses, setId, setName, setResources, setSubQueriesaddClause, addResource, addSubQuery, getClauses, getId, getName, getResources, getSubQueries, removeClause, removeResource, removeSubQuery, setClauses, setId, setName, setResources, setSubQueries, toString
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitequals, getClass, hashCode, notify, notifyAll, wait, wait, wait
| Package | +Description | +
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.controller | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.model.query | ++ |
| edu.harvard.hms.dbmi.bd2k.irct.model.resource | ++ |
| Modifier and Type | +Method and Description | +
|---|---|
java.lang.Long |
+QueryController.addJoinClause(java.lang.Long clauseId,
+ Resource resource,
+ JoinType joinType,
+ java.util.Map<java.lang.String,java.lang.String> joinFields)
+Adds a join clause
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
JoinType |
+JoinClause.getJoinType() |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+JoinClause.setJoinType(JoinType joinType) |
+
| Modifier and Type | +Method and Description | +
|---|---|
JoinType |
+Resource.getSupportedJoinByName(java.lang.String joinTypeName) |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<JoinType> |
+Resource.getSupportedJoins()
+Returns a list joins that are supported by the resource
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+Resource.setSupportedJoins(java.util.List<JoinType> supportedJoins)
+Sets the list joins that are supported by the resource
+ |
+
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.query | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.resource | -- |
| Modifier and Type | -Method and Description | -
|---|---|
LogicalOperator |
-WhereClause.getLogicalOperator()
-Returns the logical operator used to combine this where clause with other
- where clauses
- |
-
static LogicalOperator |
-LogicalOperator.valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static LogicalOperator[] |
-LogicalOperator.values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-WhereClause.setLogicalOperator(LogicalOperator logicalOperator)
-Sets the logical operator to be used to combine this where clause with
- other where clauses
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<LogicalOperator> |
-Resource.getSupportedJoins()
-Returns a list of supported joins by the resource
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-Resource.setSupportedJoins(java.util.List<LogicalOperator> supportedJoins)
-Sets the list of supported joins for the resource
- |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.query | -- |
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<PredicateTypeValue> |
-PredicateType.getValues() |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-PredicateType.setValues(java.util.List<PredicateTypeValue> values) |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.query | -- |
| Modifier and Type | -Method and Description | -
|---|---|
static PredicateTypeValueDataType |
-PredicateTypeValueDataType.valueOf(java.lang.String name)
-Returns the enum constant of this type with the specified name.
- |
-
static PredicateTypeValueDataType[] |
-PredicateTypeValueDataType.values()
-Returns an array containing the constants of this enum type, in
-the order they are declared.
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<PredicateTypeValueDataType> |
-PredicateTypeValue.getSupportedDataTypes()
-Returns a list of supported predicate types
- |
-
java.util.List<PredicateTypeValueDataType> |
-PredicateType.getSupportedDataTypes()
-Returns a list of supported data types
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-PredicateTypeValue.setSupportedDataTypes(java.util.List<PredicateTypeValueDataType> supportedDataTypes)
-Sets the supported predicate types
- |
-
void |
-PredicateType.setSupportedDataTypes(java.util.List<PredicateTypeValueDataType> supportedDataTypes)
-Sets the list of supported data types
- |
-
| Modifier and Type | +Method and Description | +
|---|---|
void |
+IRCTEventListener.afterQuery(SecureSession session,
+ Resource resource,
+ Query query)
+Runs the event listeners after a query is run
+ |
+
void |
+IRCTEventListener.beforeQuery(SecureSession session,
+ Resource resource,
+ Query query)
+Runs the event listeners before a query is run
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+BeforeQuery.fire(SecureSession session,
+ Resource resource,
+ Query query) |
+
void |
+AfterQuery.fire(SecureSession session,
+ Resource resource,
+ Query query) |
+
| Class and Description | +
|---|
| Query
+ The query class represents any query against any individual or group of
+ resources.
+ |
+
| Class and Description | +
|---|
| Query
+ The query class represents any query against any individual or group of
+ resources.
+ |
+
public interface PredicateImplementationInterface
-| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-run()
-Runs the predicate action and returns the computed results
- |
-
void |
-setAdditionalValue(java.lang.String additionalValue)
-Sets the additional value (if needed) for the predicate action
- |
-
void |
-setResultSet(ResultSet resultset)
-Sets the input result set that the predicate will be run on
- |
-
void |
-setValue(java.lang.String value)
-Sets the value (if needed) for the predicate action
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSON representation of the implementing interface
-
- Equivalent to toJson(1);
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSON representation of the implementing interface while
- converting children to JSON of a given depth
- |
-
void setResultSet(ResultSet resultset)-
resultset - The input result setvoid setValue(java.lang.String value)-
value - Valuevoid setAdditionalValue(java.lang.String additionalValue)-
additionalValue - Additional ValueResultSet run() - throws PredicateException-
PredicateException - An error occurred running the predicatejavax.json.JsonObject toJson()-
javax.json.JsonObject toJson(int depth)-
depth - Depth to travel| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.query | -- |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | -- |
| Modifier and Type | -Method and Description | -
|---|---|
PredicateImplementationInterface |
-PredicateType.getImplementingInterface()
-Returns a list of supported predicate types
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-PredicateType.setImplementingInterface(PredicateImplementationInterface implementingInterface)
-Sets the list of supported predicates types
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
PredicateImplementationInterface |
-PredicateImplementationConverter.convertToEntityAttribute(java.lang.String className) |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-PredicateImplementationConverter.convertToDatabaseColumn(PredicateImplementationInterface joinAction) |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.query | -- |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | -- |
| Class and Description | -
|---|
| PredicateImplementationInterface
- Provides an implementation that describes the API for any predicate that
- needs to be run.
- |
-
| Class and Description | -
|---|
| PredicateImplementationInterface
- Provides an implementation that describes the API for any predicate that
- needs to be run.
- |
-
public interface PathResourceImplementationInterface -extends ResourceImplementationInterface-
| Modifier and Type | -Method and Description | -
|---|---|
OntologyType |
-getOntologyType()
-Get the ontology type of this resource
- |
-
Path |
-getPathFromString(java.lang.String path)
-Turns a string into a path
- |
-
java.util.List<Path> |
-getPathRelationship(Path path,
- OntologyRelationship relationship)
-Given a path give all the associated paths of that type of relationship
- |
-
java.util.List<Path> |
-getPathRoot()
-Get the root of the resource
- |
-
OntologyRelationship |
-getRelationshipFromString(java.lang.String relationship)
-Turns a string into a relationship
- |
-
java.util.List<OntologyRelationship> |
-relationships()
-Returns the Ontology relationships
- |
-
getReturnEntity, getType, setup, toJson, toJsonjava.util.List<Path> getPathRoot()-
java.util.List<OntologyRelationship> relationships()-
OntologyRelationship getRelationshipFromString(java.lang.String relationship)-
relationship - String Representationjava.util.List<Path> getPathRelationship(Path path, - OntologyRelationship relationship) - throws ResourceInterfaceException-
path - Pathrelationship - RelationshipsResourceInterfaceException - A resource exception occurredOntologyType getOntologyType()-
Path getPathFromString(java.lang.String path)-
path - String representationpublic interface ProcessResourceImplementationInterface -extends ResourceImplementationInterface-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-getResults(ActionState actionState)
-Returns the results of the process if they are available
- |
-
ResourceState |
-getState()
-Returns the status of the resource
- |
-
ActionState |
-runProcess(IRCTProcess pep)
-Run the given process
- |
-
getReturnEntity, getType, setup, toJson, toJsonActionState runProcess(IRCTProcess pep)-
pep - Process to be runResultSet getResults(ActionState actionState) - throws ResourceInterfaceException-
actionState - Action StateResourceInterfaceException - A resource exception occurredResourceState getState()-
public interface QueryResourceImplementationInterface -extends ResourceImplementationInterface-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.Boolean |
-editableReturnEntity()
-Returns if the default entity is editable
- |
-
ResultSet |
-getResults(ActionState actionState)
-Returns the results of the query if they are available
- |
-
java.util.List<Path> |
-getReturnEntity()
-Returns the the default entity that is returned with a query
- |
-
ResourceState |
-getState()
-Returns the state of the resource
- |
-
ActionState |
-runQuery(Query qep)
-Runs the given query
- |
-
ActionState runQuery(Query qep) - throws ResourceInterfaceException-
qep - Query to be runResourceInterfaceException - A resource exception occurredResultSet getResults(ActionState actionState) - throws ResourceInterfaceException-
actionState - actionStateResourceInterfaceException - A resource exception occurredResourceState getState()-
java.util.List<Path> getReturnEntity()-
getReturnEntity in interface ResourceImplementationInterfacejava.lang.Boolean editableReturnEntity()-
java.util.List<IRCTJoin>JoinTypegetSupportedJoinByName(java.lang.String joinTypeName) java.util.List<JoinType>getSupportedJoins()
PredicateTypegetSupportedPredicateByName(java.lang.String predicateName)
java.util.List<PredicateType>getSupportedPredicates()
java.util.List<ProcessType>getSupportedProcesses()
ProcessTypegetSupportedProcessesByName(java.lang.String processName)
java.util.List<VisualizationType>getSupportedVisualizations()
booleanisSetup() voidsetDataTypes(java.util.List<DataType> dataTypes)
voidsetId(long id)
voidsetImplementingInterface(ResourceImplementationInterface implementingInterface)
voidsetLogicalOperators(java.util.List<LogicalOperator> logicalOperators)
voidsetName(java.lang.String name)
voidsetOntologyType(OntologyType ontologyType)
voidsetParameters(java.util.Map<java.lang.String,java.lang.String> parameters)
voidsetRelationships(java.util.List<OntologyRelationship> relationships)
voidsetSetup(boolean setup) voidsetSupportedJoins(java.util.List<IRCTJoin> supportedJoins)
+setSupportedJoins(java.util.List<JoinType> supportedJoins)
voidsetSupportedPredicates(java.util.List<PredicateType> supportedPredicates)
voidsetSupportedProcesses(java.util.List<ProcessType> supportedProcesses)
voidsetSupportedVisualizations(java.util.List<VisualizationType> supportedVisualizations)
voidsetup()
javax.json.JsonObjecttoJson()
javax.json.JsonObjecttoJson(int depth)
public JoinType getSupportedJoinByName(java.lang.String joinTypeName)+
public java.util.List<IRCTJoin> getSupportedJoins()+
public java.util.List<JoinType> getSupportedJoins()
public void setSupportedJoins(java.util.List<IRCTJoin> supportedJoins)+
public void setSupportedJoins(java.util.List<JoinType> supportedJoins)
public boolean isSetup()+
public void setSetup(boolean setup)+
setup - the setup to setpublic interface ResourceImplementationInterface
-| Modifier and Type | -Method and Description | -
|---|---|
java.util.List<Path> |
-getReturnEntity()
-Returns a path representation of the default object that is returned
- |
-
java.lang.String |
-getType()
-A string representation of the type of resource implementation this is
- |
-
void |
-setup(java.util.Map<java.lang.String,java.lang.String> parameters)
-A set of parameters that can used to setup the Resource Implementation
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSON representation of the implementing interface
-
- Equivalent to toJson(1);
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSON representation of the implementing interface while
- converting children to JSON of a given depth
- |
-
void setup(java.util.Map<java.lang.String,java.lang.String> parameters)-
parameters - Setup parametersjava.lang.String getType()-
java.util.List<Path> getReturnEntity()-
javax.json.JsonObject toJson()-
javax.json.JsonObject toJson(int depth)-
depth - Depth to traveljava.lang.LongaddJoinClause(java.lang.Long clauseId,
+ Resource resource,
+ JoinType joinType,
+ java.util.Map<java.lang.String,java.lang.String> joinFields)
+java.lang.LongaddSelectClause(java.lang.Long clauseId,
Resource resource,
Entity field,
@@ -274,7 +295,7 @@ Uses of Adds or updates a select clause
java.lang.LongaddWhereClause(java.lang.Long clauseId,
Resource resource,
@@ -285,21 +306,11 @@ Uses of Adds or updates a where clause to the query
java.util.List<Entity>searchForOntology(Resource resource,
- Entity resourcePath,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-java.util.List<Entity>searchForTerm(Resource resource,
+PathController.searchForTerm(Resource resource,
Entity resourcePath,
- java.lang.String searchTerm,
+ FindInformationInterface findInformation,
SecureSession session)
Searches a resource for a given searchTerm.
@@ -324,6 +335,92 @@ Uses of
+
+
+Uses of Resource in edu.harvard.hms.dbmi.bd2k.irct.event
+
+Methods in edu.harvard.hms.dbmi.bd2k.irct.event with parameters of type Resource
+
+Modifier and Type
+Method and Description
+
+
+
+voidIRCTEventListener.afterQuery(SecureSession session,
+ Resource resource,
+ Query query)
+Runs the event listeners after a query is run
+
+
+
+voidIRCTEventListener.beforeFind(Resource resource,
+ Entity resourcePath,
+ java.util.List<FindInformationInterface> findInformation,
+ SecureSession session)
+Runs the event listeners before a find is executed
+
+
+
+voidIRCTEventListener.beforeQuery(SecureSession session,
+ Resource resource,
+ Query query)
+Runs the event listeners before a query is run
+
+
+
+
+
+-
+
+
+
Uses of Resource in edu.harvard.hms.dbmi.bd2k.irct.event.action
+
+Methods in edu.harvard.hms.dbmi.bd2k.irct.event.action with parameters of type Resource
+
+Modifier and Type
+Method and Description
+
+
+
+voidBeforeQuery.fire(SecureSession session,
+ Resource resource,
+ Query query)
+
+
+voidAfterQuery.fire(SecureSession session,
+ Resource resource,
+ Query query)
+
+
+
+
+-
+
+
+
Uses of Resource in edu.harvard.hms.dbmi.bd2k.irct.event.find
+
+Methods in edu.harvard.hms.dbmi.bd2k.irct.event.find with parameters of type Resource
+
+Modifier and Type
+Method and Description
+
+
+
+voidBeforeFind.fire(Resource resource,
+ Entity resourcePath,
+ java.util.List<FindInformationInterface> findInformation,
+ SecureSession session)
+
+
+
+
-
@@ -371,7 +468,7 @@
Uses of
-java.util.List<Resource>java.util.Set<Resource>Query.getResources()
Returns a list of resources that are associated with the query
@@ -408,7 +505,7 @@ Uses of
voidQuery.setResources(java.util.List<Resource> resources)
+ Query.setResources(java.util.Set<Resource> resources)
Sets a list of resources that are associated with the query
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.resource | -- |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | -- |
| Modifier and Type | -Interface and Description | -
|---|---|
interface |
-PathResourceImplementationInterface
-Provides an implemntation that descripes tha API for any resource that has
- paths that can be traversed.
- |
-
interface |
-ProcessResourceImplementationInterface
-Provides an implementation that describes the API for any resource that has
- processes that can be run
- |
-
interface |
-QueryResourceImplementationInterface
-Provides an implementation that describes the API for any resource that has
- the ability to handle a query
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResourceImplementationInterface |
-Resource.getImplementingInterface()
-Returns the implementing interface for this resource
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-Resource.setImplementingInterface(ResourceImplementationInterface implementingInterface)
-Sets the implementing interface for this resource
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResourceImplementationInterface |
-ResourceImplementationConverter.convertToEntityAttribute(java.lang.String className) |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-ResourceImplementationConverter.convertToDatabaseColumn(ResourceImplementationInterface joinAction) |
-
java.util.List<Entity>getPathRelationship(Entity path,
- OntologyRelationship relationship,
- SecureSession session)
-find(Entity path,
+ FindInformationInterface findInformation,
+ SecureSession session)
+java.util.List<Entity>searchOntology(Entity path,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-java.util.List<Entity>searchPaths(Entity path,
- java.lang.String searchTerm,
- SecureSession session)
-getPathRelationship(Entity path,
+ OntologyRelationship relationship,
+ SecureSession session)
+java.util.List<Entity> searchPaths(Entity path, - java.lang.String searchTerm, - SecureSession session) - throws ResourceInterfaceException-
path - PathsearchTerm - Search Termsession - Secure SessionResourceInterfaceException - A resource exception occurredjava.util.List<Entity> searchOntology(Entity path, - java.lang.String ontologyType, - java.lang.String ontologyTerm, - SecureSession session) - throws ResourceInterfaceException-
java.util.List<Entity> find(Entity path, + FindInformationInterface findInformation, + SecureSession session) + throws ResourceInterfaceException+
path - PathontologyType - Ontology TypeontologyTerm - Ontology Termsession - Secure Sessionfind - Find Datasession - Session| Class and Description | +
|---|
| Resource
+ The resource class provides a way for the IRCT application to keep track of
+ which resources are available.
+ |
+
| Class and Description | +
|---|
| Resource
+ The resource class provides a way for the IRCT application to keep track of
+ which resources are available.
+ |
+
| Class and Description | +
|---|
| Resource
+ The resource class provides a way for the IRCT application to keep track of
+ which resources are available.
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
java.util.List<java.io.File> |
+getFileList() |
+
public class FileResultSet -extends ResultSetImpl -implements Persistable-
| Constructor and Description | -
|---|
FileResultSet() |
-
| Modifier and Type | -Method and Description | -
|---|---|
boolean |
-absolute(long newRow)
-Moves the cursor to the given row number in the ResultSet
- |
-
void |
-afterLast()
-Moves the cursor to the end of the ResultSet, after the last row.
- |
-
void |
-appendRow()
-Adds a new row to the file result set
- |
-
void |
-beforeFirst()
-Moves the cursor to the beginning of the ResultSet object, before the
- first row.
- |
-
boolean |
-first()
-Moves the cursor to the first row of the ResultSet object.
- |
-
boolean |
-getBoolean(int columnIndex)
-Retrieves the boolean value of the given column position at the current
- row
- |
-
boolean |
-getBoolean(java.lang.String columnLabel)
-Retrieves the boolean value of the given column at the current row
- |
-
byte |
-getByte(int columnIndex)
-Retrieves the byte value of the given column position at the current row
- |
-
byte |
-getByte(java.lang.String columnLabel)
-Retrieves the byte value of the given column at the current row
- |
-
java.util.Date |
-getDate(int columnIndex)
-Retrieves the Date value of the given column position at the current row
- |
-
java.util.Date |
-getDate(java.lang.String columnLabel)
-Retrieves the Date value of the given column at the current row
- |
-
double |
-getDouble(int columnIndex)
-Retrieves the double value of the given column position at the current
- row
- |
-
double |
-getDouble(java.lang.String columnLabel)
-Retrieves the double value of the given column at the current row
- |
-
float |
-getFloat(int columnIndex)
-Retrieves the float value of the given column position at the current row
- |
-
float |
-getFloat(java.lang.String columnLabel)
-Retrieves the float value of the given column at the current row
- |
-
int |
-getInt(int columnIndex)
-Retrieves the int value of the given column position at the current row
- |
-
int |
-getInt(java.lang.String columnLabel)
-Retrieves the int value of the given column at the current row
- |
-
long |
-getLong(int columnIndex)
-Retrieves the long value of the given column position at the current row
- |
-
long |
-getLong(java.lang.String columnLabel)
-Retrieves the long value of the given column at the current row
- |
-
java.lang.Object |
-getObject(int columnIndex)
-Returns an object representation of the value at the given column index
- |
-
long |
-getRow()
-Returns the current position of the cursor in the ResultSet object
- |
-
long |
-getSize()
-Returns the size of the ResultSetObject
- |
-
java.lang.String |
-getString(int columnIndex)
-Retrieves the String value of the given column position at the current
- row
- |
-
java.lang.String |
-getString(java.lang.String columnLabel)
-Retrieves the String value of the given column at the current row
- |
-
boolean |
-isAvailable(java.lang.String location)
-Returns if the result set can be loaded.
- |
-
boolean |
-isCurrent()
-Returns if the current result set has been persisted.
- |
-
boolean |
-isPersisted()
-Returns true if the Result Set has been persisted
- |
-
boolean |
-last()
-Moves the cursor to the last row in the ResultSet object
- |
-
void |
-load(java.lang.String fileName)
-Load the Result Set from the location specified
- |
-
void |
-merge()
-Updates the current persisted state with any changes
- |
-
boolean |
-next()
-Moves the cursor to the next row of the ResultSet object
- |
-
void |
-persist()
-Persists the result set to the long term storage
- |
-
void |
-persist(java.lang.String fileName)
-Persists the result set to the long term storage
- |
-
boolean |
-previous()
-Moves the cursor to the previous row in the ResultSet object
- |
-
void |
-refresh()
-Refreshes the result set with the persisted state.
- |
-
boolean |
-relative(long rows)
-Moves the cursor a given number of rows forward
- |
-
javax.json.JsonObject |
-toJson()
-Returns a JSONObject representation of the object.
- |
-
javax.json.JsonObject |
-toJson(int depth)
-Returns a JSONObject representation of the object.
- |
-
void |
-updateBoolean(int columnIndex,
- boolean value)
-Updates the boolean value of the given column position at the current row
- |
-
void |
-updateBoolean(java.lang.String columnLabel,
- boolean value)
-Updates the boolean value of the given column at the current row
- |
-
void |
-updateByte(int columnIndex,
- byte value)
-Updates the byte value of the given column position at the current row
- |
-
void |
-updateByte(java.lang.String columnLabel,
- byte value)
-Updates the byte value of the given column at the current row
- |
-
void |
-updateDate(int columnIndex,
- java.util.Date value)
-Updates the Date value of the given column position at the current row
- |
-
void |
-updateDate(java.lang.String columnLabel,
- java.util.Date value)
-Updates the Date value of the given column at the current row
- |
-
void |
-updateDouble(int columnIndex,
- double value)
-Updates the double value of the given column position at the current row
- |
-
void |
-updateDouble(java.lang.String columnLabel,
- double value)
-Updates the double value of the given column at the current row
- |
-
void |
-updateFloat(int columnIndex,
- float value)
-Updates the float value of the given column position at the current row
- |
-
void |
-updateFloat(java.lang.String columnLabel,
- float value)
-Updates the float value of the given column at the current row
- |
-
void |
-updateInt(int columnIndex,
- int value)
-Updates the int value of the given column position at the current row
- |
-
void |
-updateInt(java.lang.String columnLabel,
- int value)
-Updates the int value of the given column at the current row
- |
-
void |
-updateLong(int columnIndex,
- long value)
-Updates the long value of the given column position at the current row
- |
-
void |
-updateLong(java.lang.String columnLabel,
- long value)
-Updates the long value of the given column at the current row
- |
-
void |
-updateObject(int columnIndex,
- java.lang.Object obj)
-Updates the column with an object representation of the value
- |
-
void |
-updateString(int columnIndex,
- java.lang.String value)
-Updates the String value of the given column position at the current row
- |
-
void |
-updateString(java.lang.String columnLabel,
- java.lang.String value)
-Updates the String value of the given column at the current row
- |
-
appendColumn, close, findColumn, getColumn, getColumns, getColumnSize, getMatchColumnIndexes, getMatchColumnNames, getRowPosition, isClosed, isFirst, isLast, setColumns, setMatchColumn, setMatchColumn, setMatchColumn, setMatchColumns, setRowPosition, unsetMatchColumn, unsetMatchColumn, unsetMatchColumn, unsetMatchColumnequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic boolean isAvailable(java.lang.String location)-
PersistableisAvailable in interface Persistablelocation - Location of the Result Setpublic void load(java.lang.String fileName) - throws ResultSetException, - PersistableException-
Persistableload in interface PersistablefileName - LocationResultSetException - A result set exception occurredPersistableException - A persistable exception occurredpublic void appendRow() - throws ResultSetException, - PersistableException-
ResultSetException - If a ResultSetException occursPersistableException - If a PersistableException occurspublic long getSize() - throws ResultSetException-
ResultSetgetSize in interface ResultSetgetSize in class ResultSetImplResultSetException - If a ResultSetException occurspublic boolean absolute(long newRow) - throws ResultSetException-
ResultSetabsolute in interface ResultSetabsolute in class ResultSetImplnewRow - The row to move toResultSetException - If a ResultSetException occurspublic void afterLast() - throws ResultSetException-
ResultSetafterLast in interface ResultSetafterLast in class ResultSetImplResultSetException - If a ResultSetException occurspublic void beforeFirst() - throws ResultSetException-
ResultSetbeforeFirst in interface ResultSetbeforeFirst in class ResultSetImplResultSetException - If a ResultSetException occurspublic boolean first() - throws ResultSetException-
ResultSetfirst in interface ResultSetfirst in class ResultSetImplResultSetException - If a ResultSetException occurspublic boolean last() - throws ResultSetException-
ResultSetlast in interface ResultSetlast in class ResultSetImplResultSetException - If a ResultSetException occurspublic boolean next() - throws ResultSetException-
ResultSetnext in interface ResultSetnext in class ResultSetImplResultSetException - If a ResultSetException occurspublic boolean relative(long rows) - throws ResultSetException-
ResultSetrelative in interface ResultSetrelative in class ResultSetImplrows - The number of rows to move forwardResultSetException - If a ResultSetException occurspublic boolean previous() - throws ResultSetException-
ResultSetprevious in interface ResultSetprevious in class ResultSetImplResultSetException - If a ResultSetException occurspublic long getRow() - throws ResultSetException-
ResultSetgetRow in interface ResultSetgetRow in class ResultSetImplResultSetException - If a ResultSetException occurspublic void persist(java.lang.String fileName) - throws PersistableException-
Persistablepersist in interface PersistablefileName - LocationPersistableException - An error occur persisting the objectpublic void persist() - throws PersistableException-
Persistablepersist in interface PersistablePersistableException - An error occur persisting the objectpublic void merge() - throws PersistableException-
Persistablemerge in interface PersistablePersistableException - An error occur merging the objectpublic void refresh() - throws PersistableException-
Persistablerefresh in interface PersistablePersistableException - An error occur refreshing the objectpublic boolean isCurrent()-
PersistableisCurrent in interface Persistablepublic boolean isPersisted()-
PersistableisPersisted in interface Persistablepublic boolean getBoolean(int columnIndex) - throws ResultSetException-
ResultSetgetBoolean in interface ResultSetgetBoolean in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic boolean getBoolean(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetBoolean in interface ResultSetgetBoolean in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateBoolean(int columnIndex, - boolean value) - throws ResultSetException-
ResultSetupdateBoolean in interface ResultSetupdateBoolean in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateBoolean(java.lang.String columnLabel, - boolean value) - throws ResultSetException-
ResultSetupdateBoolean in interface ResultSetupdateBoolean in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic byte getByte(int columnIndex) - throws ResultSetException-
ResultSetgetByte in interface ResultSetgetByte in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic byte getByte(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetByte in interface ResultSetgetByte in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateByte(int columnIndex, - byte value) - throws ResultSetException-
ResultSetupdateByte in interface ResultSetupdateByte in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateByte(java.lang.String columnLabel, - byte value) - throws ResultSetException-
ResultSetupdateByte in interface ResultSetupdateByte in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.util.Date getDate(int columnIndex) - throws ResultSetException-
ResultSetgetDate in interface ResultSetgetDate in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic java.util.Date getDate(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetDate in interface ResultSetgetDate in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateDate(int columnIndex, - java.util.Date value) - throws ResultSetException-
ResultSetupdateDate in interface ResultSetupdateDate in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateDate(java.lang.String columnLabel, - java.util.Date value) - throws ResultSetException-
ResultSetupdateDate in interface ResultSetupdateDate in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic double getDouble(int columnIndex) - throws ResultSetException-
ResultSetgetDouble in interface ResultSetgetDouble in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic double getDouble(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetDouble in interface ResultSetgetDouble in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateDouble(int columnIndex, - double value) - throws ResultSetException-
ResultSetupdateDouble in interface ResultSetupdateDouble in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateDouble(java.lang.String columnLabel, - double value) - throws ResultSetException-
ResultSetupdateDouble in interface ResultSetupdateDouble in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic float getFloat(int columnIndex) - throws ResultSetException-
ResultSetgetFloat in interface ResultSetgetFloat in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic float getFloat(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetFloat in interface ResultSetgetFloat in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateFloat(int columnIndex, - float value) - throws ResultSetException-
ResultSetupdateFloat in interface ResultSetupdateFloat in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateFloat(java.lang.String columnLabel, - float value) - throws ResultSetException-
ResultSetupdateFloat in interface ResultSetupdateFloat in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic int getInt(int columnIndex) - throws ResultSetException-
ResultSetgetInt in interface ResultSetgetInt in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic int getInt(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetInt in interface ResultSetgetInt in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateInt(int columnIndex, - int value) - throws ResultSetException-
ResultSetupdateInt in interface ResultSetupdateInt in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateInt(java.lang.String columnLabel, - int value) - throws ResultSetException-
ResultSetupdateInt in interface ResultSetupdateInt in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic long getLong(int columnIndex) - throws ResultSetException-
ResultSetgetLong in interface ResultSetgetLong in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic long getLong(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetLong in interface ResultSetgetLong in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateLong(int columnIndex, - long value) - throws ResultSetException-
ResultSetupdateLong in interface ResultSetupdateLong in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateLong(java.lang.String columnLabel, - long value) - throws ResultSetException-
ResultSetupdateLong in interface ResultSetupdateLong in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.lang.String getString(int columnIndex) - throws ResultSetException-
ResultSetgetString in interface ResultSetgetString in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic java.lang.String getString(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetString in interface ResultSetgetString in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateString(int columnIndex, - java.lang.String value) - throws ResultSetException-
ResultSetupdateString in interface ResultSetupdateString in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateString(java.lang.String columnLabel, - java.lang.String value) - throws ResultSetException-
ResultSetupdateString in interface ResultSetupdateString in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.lang.Object getObject(int columnIndex) - throws ResultSetException-
JoinablegetObject in interface JoinablegetObject in class ResultSetImplcolumnIndex - The column starting at position 0ResultSetException - If a ResultSetException occurspublic void updateObject(int columnIndex, - java.lang.Object obj) - throws ResultSetException-
JoinableupdateObject in interface JoinableupdateObject in class ResultSetImplcolumnIndex - The column starting at position 0obj - The new column valueResultSetException - If a ResultSetException occurspublic javax.json.JsonObject toJson()-
public javax.json.JsonObject toJson(int depth)-
depth - Depth to travelpublic interface Joinable
-| Modifier and Type | -Method and Description | -
|---|---|
int[] |
-getMatchColumnIndexes()
-Gets the indexes of the columns that are to be matched
- |
-
java.lang.String[] |
-getMatchColumnNames()
-Gets the names of the columns that are to be matched
- |
-
java.lang.Object |
-getObject(int columnIndex)
-Returns an object representation of the value at the given column index
- |
-
void |
-setMatchColumn(int columnIndex)
-Sets the designated column index to be joined on
- |
-
void |
-setMatchColumn(int[] columnIndexes)
-Sets the designated columns by index to be joined on
- |
-
void |
-setMatchColumn(java.lang.String columnLabel)
-Sets the designated column label to be joined on
- |
-
void |
-setMatchColumns(java.lang.String[] columnLabels)
-Sets the designated columns by label to be joined on
- |
-
void |
-unsetMatchColumn(int columnIndex)
-Unsets the given column as a joining column
- |
-
void |
-unsetMatchColumn(int[] columnIndexes)
-Unsets the given columns as a joining column
- |
-
void |
-unsetMatchColumn(java.lang.String columnLabel)
-Unsets the given column as a joining column
- |
-
void |
-unsetMatchColumn(java.lang.String[] columnLabels)
-Unsets the given columns as a joining column
- |
-
void |
-updateObject(int columnIndex,
- java.lang.Object obj)
-Updates the column with an object representation of the value
- |
-
java.lang.Object getObject(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 0ResultSetException - If a ResultSetException occursvoid updateObject(int columnIndex, - java.lang.Object obj) - throws ResultSetException-
columnIndex - The column starting at position 0obj - The new column valueResultSetException - If a ResultSetException occursint[] getMatchColumnIndexes() - throws ResultSetException-
ResultSetException - If a ResultSetException occursjava.lang.String[] getMatchColumnNames() - throws ResultSetException-
ResultSetException - If a ResultSetException occursvoid setMatchColumn(int columnIndex) - throws ResultSetException-
columnIndex - the column index to join onResultSetException - If a ResultSetException occursvoid setMatchColumn(int[] columnIndexes) - throws ResultSetException-
columnIndexes - the column indexes to join onResultSetException - If a ResultSetException occursvoid setMatchColumn(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the column index to join onResultSetException - If a ResultSetException occursvoid setMatchColumns(java.lang.String[] columnLabels) - throws ResultSetException-
columnLabels - the column labels to join onResultSetException - If a ResultSetException occursvoid unsetMatchColumn(int columnIndex) - throws ResultSetException-
columnIndex - the index of the column to no longer match onResultSetException - If a ResultSetException occursvoid unsetMatchColumn(int[] columnIndexes) - throws ResultSetException-
columnIndexes - the indexes of the column to no longer match onResultSetException - If a ResultSetException occursvoid unsetMatchColumn(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the label of the column to no longer match onResultSetException - If a ResultSetException occursvoid unsetMatchColumn(java.lang.String[] columnLabels) - throws ResultSetException-
columnLabels - the index of the column to no longer match onResultSetException - If a ResultSetException occurspublic class MemoryResultSet -extends ResultSetImpl-
| Constructor and Description | -
|---|
MemoryResultSet() |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-appendRow()
-Adds a new row to the memory result set
- |
-
boolean |
-getBoolean(int columnIndex)
-Retrieves the boolean value of the given column position at the current
- row
- |
-
boolean |
-getBoolean(java.lang.String columnLabel)
-Retrieves the boolean value of the given column at the current row
- |
-
byte |
-getByte(int columnIndex)
-Retrieves the byte value of the given column position at the current row
- |
-
byte |
-getByte(java.lang.String columnLabel)
-Retrieves the byte value of the given column at the current row
- |
-
java.util.Date |
-getDate(int columnIndex)
-Retrieves the Date value of the given column position at the current row
- |
-
java.util.Date |
-getDate(java.lang.String columnLabel)
-Retrieves the Date value of the given column at the current row
- |
-
double |
-getDouble(int columnIndex)
-Retrieves the double value of the given column position at the current
- row
- |
-
double |
-getDouble(java.lang.String columnLabel)
-Retrieves the double value of the given column at the current row
- |
-
float |
-getFloat(int columnIndex)
-Retrieves the float value of the given column position at the current row
- |
-
float |
-getFloat(java.lang.String columnLabel)
-Retrieves the float value of the given column at the current row
- |
-
int |
-getInt(int columnIndex)
-Retrieves the int value of the given column position at the current row
- |
-
int |
-getInt(java.lang.String columnLabel)
-Retrieves the int value of the given column at the current row
- |
-
long |
-getLong(int columnIndex)
-Retrieves the long value of the given column position at the current row
- |
-
long |
-getLong(java.lang.String columnLabel)
-Retrieves the long value of the given column at the current row
- |
-
java.lang.Object |
-getObject(int columnIndex)
-Returns an object representation of the value at the given column index
- |
-
long |
-getSize()
-Returns the size of the ResultSetObject
- |
-
java.lang.String |
-getString(int columnIndex)
-Retrieves the String value of the given column position at the current
- row
- |
-
java.lang.String |
-getString(java.lang.String columnLabel)
-Retrieves the String value of the given column at the current row
- |
-
void |
-updateBoolean(int columnIndex,
- boolean value)
-Updates the boolean value of the given column position at the current row
- |
-
void |
-updateBoolean(java.lang.String columnLabel,
- boolean value)
-Updates the boolean value of the given column at the current row
- |
-
void |
-updateByte(int columnIndex,
- byte value)
-Updates the byte value of the given column position at the current row
- |
-
void |
-updateByte(java.lang.String columnLabel,
- byte value)
-Updates the byte value of the given column at the current row
- |
-
void |
-updateDate(int columnIndex,
- java.util.Date value)
-Updates the Date value of the given column position at the current row
- |
-
void |
-updateDate(java.lang.String columnLabel,
- java.util.Date value)
-Updates the Date value of the given column at the current row
- |
-
void |
-updateDouble(int columnIndex,
- double value)
-Updates the double value of the given column position at the current row
- |
-
void |
-updateDouble(java.lang.String columnLabel,
- double value)
-Updates the double value of the given column at the current row
- |
-
void |
-updateFloat(int columnIndex,
- float value)
-Updates the float value of the given column position at the current row
- |
-
void |
-updateFloat(java.lang.String columnLabel,
- float value)
-Updates the float value of the given column at the current row
- |
-
void |
-updateInt(int columnIndex,
- int value)
-Updates the int value of the given column position at the current row
- |
-
void |
-updateInt(java.lang.String columnLabel,
- int value)
-Updates the int value of the given column at the current row
- |
-
void |
-updateLong(int columnIndex,
- long value)
-Updates the long value of the given column position at the current row
- |
-
void |
-updateLong(java.lang.String columnLabel,
- long value)
-Updates the long value of the given column at the current row
- |
-
void |
-updateObject(int columnIndex,
- java.lang.Object obj)
-Updates the column with an object representation of the value
- |
-
void |
-updateString(int columnIndex,
- java.lang.String value)
-Updates the String value of the given column position at the current row
- |
-
void |
-updateString(java.lang.String columnLabel,
- java.lang.String value)
-Updates the String value of the given column at the current row
- |
-
absolute, afterLast, appendColumn, beforeFirst, close, findColumn, first, getColumn, getColumns, getColumnSize, getMatchColumnIndexes, getMatchColumnNames, getRow, getRowPosition, isClosed, isFirst, isLast, last, next, previous, relative, setColumns, setMatchColumn, setMatchColumn, setMatchColumn, setMatchColumns, setRowPosition, unsetMatchColumn, unsetMatchColumn, unsetMatchColumn, unsetMatchColumnequals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void appendRow() - throws ResultSetException-
ResultSetException - If a ResultSetException occurspublic long getSize() - throws ResultSetException-
ResultSetgetSize in interface ResultSetgetSize in class ResultSetImplResultSetException - If a ResultSetException occurspublic boolean getBoolean(int columnIndex) - throws ResultSetException-
ResultSetgetBoolean in interface ResultSetgetBoolean in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic boolean getBoolean(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetBoolean in interface ResultSetgetBoolean in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateBoolean(int columnIndex, - boolean value) - throws ResultSetException-
ResultSetupdateBoolean in interface ResultSetupdateBoolean in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateBoolean(java.lang.String columnLabel, - boolean value) - throws ResultSetException-
ResultSetupdateBoolean in interface ResultSetupdateBoolean in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic byte getByte(int columnIndex) - throws ResultSetException-
ResultSetgetByte in interface ResultSetgetByte in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic byte getByte(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetByte in interface ResultSetgetByte in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateByte(int columnIndex, - byte value) - throws ResultSetException-
ResultSetupdateByte in interface ResultSetupdateByte in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateByte(java.lang.String columnLabel, - byte value) - throws ResultSetException-
ResultSetupdateByte in interface ResultSetupdateByte in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.util.Date getDate(int columnIndex) - throws ResultSetException-
ResultSetgetDate in interface ResultSetgetDate in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic java.util.Date getDate(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetDate in interface ResultSetgetDate in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateDate(int columnIndex, - java.util.Date value) - throws ResultSetException-
ResultSetupdateDate in interface ResultSetupdateDate in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateDate(java.lang.String columnLabel, - java.util.Date value) - throws ResultSetException-
ResultSetupdateDate in interface ResultSetupdateDate in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic double getDouble(int columnIndex) - throws ResultSetException-
ResultSetgetDouble in interface ResultSetgetDouble in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic double getDouble(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetDouble in interface ResultSetgetDouble in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateDouble(int columnIndex, - double value) - throws ResultSetException-
ResultSetupdateDouble in interface ResultSetupdateDouble in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateDouble(java.lang.String columnLabel, - double value) - throws ResultSetException-
ResultSetupdateDouble in interface ResultSetupdateDouble in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic float getFloat(int columnIndex) - throws ResultSetException-
ResultSetgetFloat in interface ResultSetgetFloat in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic float getFloat(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetFloat in interface ResultSetgetFloat in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateFloat(int columnIndex, - float value) - throws ResultSetException-
ResultSetupdateFloat in interface ResultSetupdateFloat in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateFloat(java.lang.String columnLabel, - float value) - throws ResultSetException-
ResultSetupdateFloat in interface ResultSetupdateFloat in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic int getInt(int columnIndex) - throws ResultSetException-
ResultSetgetInt in interface ResultSetgetInt in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic int getInt(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetInt in interface ResultSetgetInt in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateInt(int columnIndex, - int value) - throws ResultSetException-
ResultSetupdateInt in interface ResultSetupdateInt in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateInt(java.lang.String columnLabel, - int value) - throws ResultSetException-
ResultSetupdateInt in interface ResultSetupdateInt in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic long getLong(int columnIndex) - throws ResultSetException-
ResultSetgetLong in interface ResultSetgetLong in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic long getLong(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetLong in interface ResultSetgetLong in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateLong(int columnIndex, - long value) - throws ResultSetException-
ResultSetupdateLong in interface ResultSetupdateLong in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateLong(java.lang.String columnLabel, - long value) - throws ResultSetException-
ResultSetupdateLong in interface ResultSetupdateLong in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.lang.String getString(int columnIndex) - throws ResultSetException-
ResultSetgetString in interface ResultSetgetString in class ResultSetImplcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic java.lang.String getString(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetString in interface ResultSetgetString in class ResultSetImplcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateString(int columnIndex, - java.lang.String value) - throws ResultSetException-
ResultSetupdateString in interface ResultSetupdateString in class ResultSetImplcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateString(java.lang.String columnLabel, - java.lang.String value) - throws ResultSetException-
ResultSetupdateString in interface ResultSetupdateString in class ResultSetImplcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.lang.Object getObject(int columnIndex) - throws ResultSetException-
JoinablegetObject in interface JoinablegetObject in class ResultSetImplcolumnIndex - The column starting at position 0ResultSetException - If a ResultSetException occurspublic void updateObject(int columnIndex, - java.lang.Object obj) - throws ResultSetException-
JoinableupdateObject in interface JoinableupdateObject in class ResultSetImplcolumnIndex - The column starting at position 0obj - The new column valueResultSetException - If a ResultSetException occurspublic interface ResultSet
-| Modifier and Type | -Method and Description | -
|---|---|
boolean |
-absolute(long row)
-Moves the cursor to the given row number in the ResultSet
- |
-
void |
-afterLast()
-Moves the cursor to the end of the ResultSet, after the last row.
- |
-
void |
-beforeFirst()
-Moves the cursor to the beginning of the ResultSet object, before the
- first row.
- |
-
void |
-close()
-Releases the connection to the datasource
- |
-
int |
-findColumn(java.lang.String columnLabel)
-Returns the position of the given column in the ResultSet object
- |
-
boolean |
-first()
-Moves the cursor to the first row of the ResultSet object.
- |
-
boolean |
-getBoolean(int columnIndex)
-Retrieves the boolean value of the given column position at the current
- row
- |
-
boolean |
-getBoolean(java.lang.String columnLabel)
-Retrieves the boolean value of the given column at the current row
- |
-
byte |
-getByte(int columnIndex)
-Retrieves the byte value of the given column position at the current row
- |
-
byte |
-getByte(java.lang.String columnLabel)
-Retrieves the byte value of the given column at the current row
- |
-
Column |
-getColumn(int columnIndex)
-Gets the column associated with the columnIndex
- |
-
Column[] |
-getColumns()
-Returns an array of columns associated with the result set
- |
-
int |
-getColumnSize()
-Returns the column size
- |
-
java.util.Date |
-getDate(int columnIndex)
-Retrieves the Date value of the given column position at the current row
- |
-
java.util.Date |
-getDate(java.lang.String columnLabel)
-Retrieves the Date value of the given column at the current row
- |
-
double |
-getDouble(int columnIndex)
-Retrieves the double value of the given column position at the current
- row
- |
-
double |
-getDouble(java.lang.String columnLabel)
-Retrieves the double value of the given column at the current row
- |
-
float |
-getFloat(int columnIndex)
-Retrieves the float value of the given column position at the current row
- |
-
float |
-getFloat(java.lang.String columnLabel)
-Retrieves the float value of the given column at the current row
- |
-
int |
-getInt(int columnIndex)
-Retrieves the int value of the given column position at the current row
- |
-
int |
-getInt(java.lang.String columnLabel)
-Retrieves the int value of the given column at the current row
- |
-
long |
-getLong(int columnIndex)
-Retrieves the long value of the given column position at the current row
- |
-
long |
-getLong(java.lang.String columnLabel)
-Retrieves the long value of the given column at the current row
- |
-
long |
-getRow()
-Returns the current position of the cursor in the ResultSet object
- |
-
long |
-getSize()
-Returns the size of the ResultSetObject
- |
-
java.lang.String |
-getString(int columnIndex)
-Retrieves the String value of the given column position at the current
- row
- |
-
java.lang.String |
-getString(java.lang.String columnLabel)
-Retrieves the String value of the given column at the current row
- |
-
boolean |
-isClosed()
-Returns the status of the connection to the datasource
- |
-
boolean |
-isFirst()
-Retrieves if the cursor is on the first row in the ResultSet object
- |
-
boolean |
-isLast()
-Retrieves if the cursor is on the last row in the ResultSet object
- |
-
boolean |
-last()
-Moves the cursor to the last row in the ResultSet object
- |
-
boolean |
-next()
-Moves the cursor to the next row of the ResultSet object
- |
-
boolean |
-previous()
-Moves the cursor to the previous row in the ResultSet object
- |
-
boolean |
-relative(long rows)
-Moves the cursor a given number of rows forward
- |
-
void |
-updateBoolean(int columnIndex,
- boolean value)
-Updates the boolean value of the given column position at the current row
- |
-
void |
-updateBoolean(java.lang.String columnLabel,
- boolean value)
-Updates the boolean value of the given column at the current row
- |
-
void |
-updateByte(int columnIndex,
- byte value)
-Updates the byte value of the given column position at the current row
- |
-
void |
-updateByte(java.lang.String columnLabel,
- byte value)
-Updates the byte value of the given column at the current row
- |
-
void |
-updateDate(int columnIndex,
- java.util.Date value)
-Updates the Date value of the given column position at the current row
- |
-
void |
-updateDate(java.lang.String columnLabel,
- java.util.Date value)
-Updates the Date value of the given column at the current row
- |
-
void |
-updateDouble(int columnIndex,
- double value)
-Updates the double value of the given column position at the current row
- |
-
void |
-updateDouble(java.lang.String columnLabel,
- double value)
-Updates the double value of the given column at the current row
- |
-
void |
-updateFloat(int columnIndex,
- float value)
-Updates the float value of the given column position at the current row
- |
-
void |
-updateFloat(java.lang.String columnLabel,
- float value)
-Updates the float value of the given column at the current row
- |
-
void |
-updateInt(int columnIndex,
- int value)
-Updates the int value of the given column position at the current row
- |
-
void |
-updateInt(java.lang.String columnLabel,
- int value)
-Updates the int value of the given column at the current row
- |
-
void |
-updateLong(int columnIndex,
- long value)
-Updates the long value of the given column position at the current row
- |
-
void |
-updateLong(java.lang.String columnLabel,
- long value)
-Updates the long value of the given column at the current row
- |
-
void |
-updateString(int columnIndex,
- java.lang.String value)
-Updates the String value of the given column position at the current row
- |
-
void |
-updateString(java.lang.String columnLabel,
- java.lang.String value)
-Updates the String value of the given column at the current row
- |
-
void close() - throws ResultSetException-
ResultSetException - If a ResultSetException occursboolean isClosed()-
boolean absolute(long row) - throws ResultSetException-
row - The row to move toResultSetException - If a ResultSetException occursvoid afterLast() - throws ResultSetException-
ResultSetException - If a ResultSetException occursvoid beforeFirst() - throws ResultSetException-
ResultSetException - If a ResultSetException occursboolean first() - throws ResultSetException-
ResultSetException - If a ResultSetException occursboolean next() - throws ResultSetException-
ResultSetException - If a ResultSetException occursboolean relative(long rows) - throws ResultSetException-
rows - The number of rows to move forwardResultSetException - If a ResultSetException occursboolean previous() - throws ResultSetException-
ResultSetException - If a ResultSetException occursboolean last() - throws ResultSetException-
ResultSetException - If a ResultSetException occursboolean isFirst() - throws ResultSetException-
ResultSetException - If a ResultSetException occursboolean isLast() - throws ResultSetException-
ResultSetException - If a ResultSetException occurslong getRow() - throws ResultSetException-
ResultSetException - If a ResultSetException occurslong getSize() - throws ResultSetException-
ResultSetException - If a ResultSetException occursint findColumn(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - The name of the columnResultSetException - If a ResultSetException occursColumn getColumn(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occursColumn[] getColumns() - throws ResultSetException-
ResultSetException - If a ResultSetException occursboolean getBoolean(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occursboolean getBoolean(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occursvoid updateBoolean(int columnIndex, - boolean value) - throws ResultSetException-
columnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occursvoid updateBoolean(java.lang.String columnLabel, - boolean value) - throws ResultSetException-
columnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occursbyte getByte(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occursbyte getByte(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occursvoid updateByte(int columnIndex, - byte value) - throws ResultSetException-
columnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occursvoid updateByte(java.lang.String columnLabel, - byte value) - throws ResultSetException-
columnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occursjava.util.Date getDate(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occursjava.util.Date getDate(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occursvoid updateDate(int columnIndex, - java.util.Date value) - throws ResultSetException-
columnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occursvoid updateDate(java.lang.String columnLabel, - java.util.Date value) - throws ResultSetException-
columnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occursdouble getDouble(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occursdouble getDouble(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occursvoid updateDouble(int columnIndex, - double value) - throws ResultSetException-
columnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occursvoid updateDouble(java.lang.String columnLabel, - double value) - throws ResultSetException-
columnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occursfloat getFloat(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occursfloat getFloat(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occursvoid updateFloat(int columnIndex, - float value) - throws ResultSetException-
columnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occursvoid updateFloat(java.lang.String columnLabel, - float value) - throws ResultSetException-
columnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occursint getInt(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occursint getInt(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occursvoid updateInt(int columnIndex, - int value) - throws ResultSetException-
columnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occursvoid updateInt(java.lang.String columnLabel, - int value) - throws ResultSetException-
columnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurslong getLong(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurslong getLong(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occursvoid updateLong(int columnIndex, - long value) - throws ResultSetException-
columnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occursvoid updateLong(java.lang.String columnLabel, - long value) - throws ResultSetException-
columnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occursjava.lang.String getString(int columnIndex) - throws ResultSetException-
columnIndex - The column starting at position 1ResultSetException - If a ResultSetException occursjava.lang.String getString(java.lang.String columnLabel) - throws ResultSetException-
columnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occursvoid updateString(int columnIndex, - java.lang.String value) - throws ResultSetException-
columnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occursvoid updateString(java.lang.String columnLabel, - java.lang.String value) - throws ResultSetException-
columnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occursint getColumnSize() - throws ResultSetException-
ResultSetException - If a ResultSetException occurspublic class ResultSetImpl -extends java.lang.Object -implements ResultSet, Joinable-
| Constructor and Description | -
|---|
ResultSetImpl() |
-
| Modifier and Type | -Method and Description | -
|---|---|
boolean |
-absolute(long row)
-Moves the cursor to the given row number in the ResultSet
- |
-
void |
-afterLast()
-Moves the cursor to the end of the ResultSet, after the last row.
- |
-
void |
-appendColumn(Column column)
-Adds a new column to a Result Set.
- |
-
void |
-beforeFirst()
-Moves the cursor to the beginning of the ResultSet object, before the
- first row.
- |
-
void |
-close()
-Releases the connection to the datasource
- |
-
int |
-findColumn(java.lang.String columnLabel)
-Returns the position of the given column in the ResultSet object
- |
-
boolean |
-first()
-Moves the cursor to the first row of the ResultSet object.
- |
-
boolean |
-getBoolean(int columnIndex)
-Retrieves the boolean value of the given column position at the current
- row
- |
-
boolean |
-getBoolean(java.lang.String columnLabel)
-Retrieves the boolean value of the given column at the current row
- |
-
byte |
-getByte(int columnIndex)
-Retrieves the byte value of the given column position at the current row
- |
-
byte |
-getByte(java.lang.String columnLabel)
-Retrieves the byte value of the given column at the current row
- |
-
Column |
-getColumn(int columnIndex)
-Gets the column associated with the columnIndex
- |
-
Column[] |
-getColumns()
-Returns an array of columns associated with the result set
- |
-
int |
-getColumnSize()
-Returns the column size
- |
-
java.util.Date |
-getDate(int columnIndex)
-Retrieves the Date value of the given column position at the current row
- |
-
java.util.Date |
-getDate(java.lang.String columnLabel)
-Retrieves the Date value of the given column at the current row
- |
-
double |
-getDouble(int columnIndex)
-Retrieves the double value of the given column position at the current
- row
- |
-
double |
-getDouble(java.lang.String columnLabel)
-Retrieves the double value of the given column at the current row
- |
-
float |
-getFloat(int columnIndex)
-Retrieves the float value of the given column position at the current row
- |
-
float |
-getFloat(java.lang.String columnLabel)
-Retrieves the float value of the given column at the current row
- |
-
int |
-getInt(int columnIndex)
-Retrieves the int value of the given column position at the current row
- |
-
int |
-getInt(java.lang.String columnLabel)
-Retrieves the int value of the given column at the current row
- |
-
long |
-getLong(int columnIndex)
-Retrieves the long value of the given column position at the current row
- |
-
long |
-getLong(java.lang.String columnLabel)
-Retrieves the long value of the given column at the current row
- |
-
int[] |
-getMatchColumnIndexes()
-Gets the indexes of the columns that are to be matched
- |
-
java.lang.String[] |
-getMatchColumnNames()
-Gets the names of the columns that are to be matched
- |
-
java.lang.Object |
-getObject(int columnIndex)
-Returns an object representation of the value at the given column index
- |
-
long |
-getRow()
-Returns the current position of the cursor in the ResultSet object
- |
-
long |
-getRowPosition() |
-
long |
-getSize()
-Returns the size of the ResultSetObject
- |
-
java.lang.String |
-getString(int columnIndex)
-Retrieves the String value of the given column position at the current
- row
- |
-
java.lang.String |
-getString(java.lang.String columnLabel)
-Retrieves the String value of the given column at the current row
- |
-
boolean |
-isClosed()
-Returns the status of the connection to the datasource
- |
-
boolean |
-isFirst()
-Retrieves if the cursor is on the first row in the ResultSet object
- |
-
boolean |
-isLast()
-Retrieves if the cursor is on the last row in the ResultSet object
- |
-
boolean |
-last()
-Moves the cursor to the last row in the ResultSet object
- |
-
boolean |
-next()
-Moves the cursor to the next row of the ResultSet object
- |
-
boolean |
-previous()
-Moves the cursor to the previous row in the ResultSet object
- |
-
boolean |
-relative(long rows)
-Moves the cursor a given number of rows forward
- |
-
void |
-setColumns(Column[] columns) |
-
void |
-setMatchColumn(int columnIndex)
-Sets the designated column index to be joined on
- |
-
void |
-setMatchColumn(int[] columnIndexes)
-Sets the designated columns by index to be joined on
- |
-
void |
-setMatchColumn(java.lang.String columnLabel)
-Sets the designated column label to be joined on
- |
-
void |
-setMatchColumns(java.lang.String[] columnLabels)
-Sets the designated columns by label to be joined on
- |
-
void |
-setRowPosition(long rowPosition) |
-
void |
-unsetMatchColumn(int columnIndex)
-Unsets the given column as a joining column
- |
-
void |
-unsetMatchColumn(int[] columnIndexes)
-Unsets the given columns as a joining column
- |
-
void |
-unsetMatchColumn(java.lang.String columnLabel)
-Unsets the given column as a joining column
- |
-
void |
-unsetMatchColumn(java.lang.String[] columnLabels)
-Unsets the given columns as a joining column
- |
-
void |
-updateBoolean(int columnIndex,
- boolean value)
-Updates the boolean value of the given column position at the current row
- |
-
void |
-updateBoolean(java.lang.String columnLabel,
- boolean value)
-Updates the boolean value of the given column at the current row
- |
-
void |
-updateByte(int columnIndex,
- byte value)
-Updates the byte value of the given column position at the current row
- |
-
void |
-updateByte(java.lang.String columnLabel,
- byte value)
-Updates the byte value of the given column at the current row
- |
-
void |
-updateDate(int columnIndex,
- java.util.Date value)
-Updates the Date value of the given column position at the current row
- |
-
void |
-updateDate(java.lang.String columnLabel,
- java.util.Date value)
-Updates the Date value of the given column at the current row
- |
-
void |
-updateDouble(int columnIndex,
- double value)
-Updates the double value of the given column position at the current row
- |
-
void |
-updateDouble(java.lang.String columnLabel,
- double value)
-Updates the double value of the given column at the current row
- |
-
void |
-updateFloat(int columnIndex,
- float value)
-Updates the float value of the given column position at the current row
- |
-
void |
-updateFloat(java.lang.String columnLabel,
- float value)
-Updates the float value of the given column at the current row
- |
-
void |
-updateInt(int columnIndex,
- int value)
-Updates the int value of the given column position at the current row
- |
-
void |
-updateInt(java.lang.String columnLabel,
- int value)
-Updates the int value of the given column at the current row
- |
-
void |
-updateLong(int columnIndex,
- long value)
-Updates the long value of the given column position at the current row
- |
-
void |
-updateLong(java.lang.String columnLabel,
- long value)
-Updates the long value of the given column at the current row
- |
-
void |
-updateObject(int columnIndex,
- java.lang.Object obj)
-Updates the column with an object representation of the value
- |
-
void |
-updateString(int columnIndex,
- java.lang.String value)
-Updates the String value of the given column position at the current row
- |
-
void |
-updateString(java.lang.String columnLabel,
- java.lang.String value)
-Updates the String value of the given column at the current row
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic void appendColumn(Column column) - throws ResultSetException-
column - New ColumnResultSetException - If a ResultSetException occurspublic int[] getMatchColumnIndexes() - throws ResultSetException-
JoinablegetMatchColumnIndexes in interface JoinableResultSetException - If a ResultSetException occurspublic java.lang.String[] getMatchColumnNames() - throws ResultSetException-
JoinablegetMatchColumnNames in interface JoinableResultSetException - If a ResultSetException occurspublic void setMatchColumn(int columnIndex) - throws ResultSetException-
JoinablesetMatchColumn in interface JoinablecolumnIndex - the column index to join onResultSetException - If a ResultSetException occurspublic void setMatchColumn(int[] columnIndexes) - throws ResultSetException-
JoinablesetMatchColumn in interface JoinablecolumnIndexes - the column indexes to join onResultSetException - If a ResultSetException occurspublic void setMatchColumn(java.lang.String columnLabel) - throws ResultSetException-
JoinablesetMatchColumn in interface JoinablecolumnLabel - the column index to join onResultSetException - If a ResultSetException occurspublic void setMatchColumns(java.lang.String[] columnLabels) - throws ResultSetException-
JoinablesetMatchColumns in interface JoinablecolumnLabels - the column labels to join onResultSetException - If a ResultSetException occurspublic void unsetMatchColumn(int columnIndex) - throws ResultSetException-
JoinableunsetMatchColumn in interface JoinablecolumnIndex - the index of the column to no longer match onResultSetException - If a ResultSetException occurspublic void unsetMatchColumn(int[] columnIndexes) - throws ResultSetException-
JoinableunsetMatchColumn in interface JoinablecolumnIndexes - the indexes of the column to no longer match onResultSetException - If a ResultSetException occurspublic void unsetMatchColumn(java.lang.String columnLabel) - throws ResultSetException-
JoinableunsetMatchColumn in interface JoinablecolumnLabel - the label of the column to no longer match onResultSetException - If a ResultSetException occurspublic void unsetMatchColumn(java.lang.String[] columnLabels) - throws ResultSetException-
JoinableunsetMatchColumn in interface JoinablecolumnLabels - the index of the column to no longer match onResultSetException - If a ResultSetException occurspublic void close() - throws ResultSetException-
ResultSetclose in interface ResultSetResultSetException - If a ResultSetException occurspublic boolean isClosed()-
ResultSetpublic boolean absolute(long row) - throws ResultSetException-
ResultSetabsolute in interface ResultSetrow - The row to move toResultSetException - If a ResultSetException occurspublic void afterLast() - throws ResultSetException-
ResultSetafterLast in interface ResultSetResultSetException - If a ResultSetException occurspublic void beforeFirst() - throws ResultSetException-
ResultSetbeforeFirst in interface ResultSetResultSetException - If a ResultSetException occurspublic boolean first() - throws ResultSetException-
ResultSetfirst in interface ResultSetResultSetException - If a ResultSetException occurspublic boolean next() - throws ResultSetException-
ResultSetnext in interface ResultSetResultSetException - If a ResultSetException occurspublic boolean relative(long rows) - throws ResultSetException-
ResultSetrelative in interface ResultSetrows - The number of rows to move forwardResultSetException - If a ResultSetException occurspublic boolean previous() - throws ResultSetException-
ResultSetprevious in interface ResultSetResultSetException - If a ResultSetException occurspublic boolean last() - throws ResultSetException-
ResultSetlast in interface ResultSetResultSetException - If a ResultSetException occurspublic boolean isFirst() - throws ResultSetException-
ResultSetisFirst in interface ResultSetResultSetException - If a ResultSetException occurspublic boolean isLast() - throws ResultSetException-
ResultSetisLast in interface ResultSetResultSetException - If a ResultSetException occurspublic long getRow() - throws ResultSetException-
ResultSetgetRow in interface ResultSetResultSetException - If a ResultSetException occurspublic long getSize() - throws ResultSetException-
ResultSetgetSize in interface ResultSetResultSetException - If a ResultSetException occurspublic int getColumnSize() - throws ResultSetException-
ResultSetgetColumnSize in interface ResultSetResultSetException - If a ResultSetException occurspublic int findColumn(java.lang.String columnLabel) - throws ResultSetException-
ResultSetfindColumn in interface ResultSetcolumnLabel - The name of the columnResultSetException - If a ResultSetException occurspublic Column getColumn(int columnIndex) - throws ResultSetException-
ResultSetgetColumn in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic Column[] getColumns() - throws ResultSetException-
ResultSetgetColumns in interface ResultSetResultSetException - If a ResultSetException occurspublic void setColumns(Column[] columns) - throws ResultSetException-
ResultSetExceptionpublic boolean getBoolean(int columnIndex) - throws ResultSetException-
ResultSetgetBoolean in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic boolean getBoolean(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetBoolean in interface ResultSetcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateBoolean(int columnIndex, - boolean value) - throws ResultSetException-
ResultSetupdateBoolean in interface ResultSetcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateBoolean(java.lang.String columnLabel, - boolean value) - throws ResultSetException-
ResultSetupdateBoolean in interface ResultSetcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic byte getByte(int columnIndex) - throws ResultSetException-
ResultSetgetByte in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic byte getByte(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetByte in interface ResultSetcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateByte(int columnIndex, - byte value) - throws ResultSetException-
ResultSetupdateByte in interface ResultSetcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateByte(java.lang.String columnLabel, - byte value) - throws ResultSetException-
ResultSetupdateByte in interface ResultSetcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.util.Date getDate(int columnIndex) - throws ResultSetException-
ResultSetgetDate in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic java.util.Date getDate(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetDate in interface ResultSetcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateDate(int columnIndex, - java.util.Date value) - throws ResultSetException-
ResultSetupdateDate in interface ResultSetcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateDate(java.lang.String columnLabel, - java.util.Date value) - throws ResultSetException-
ResultSetupdateDate in interface ResultSetcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic double getDouble(int columnIndex) - throws ResultSetException-
ResultSetgetDouble in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic double getDouble(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetDouble in interface ResultSetcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateDouble(int columnIndex, - double value) - throws ResultSetException-
ResultSetupdateDouble in interface ResultSetcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateDouble(java.lang.String columnLabel, - double value) - throws ResultSetException-
ResultSetupdateDouble in interface ResultSetcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic float getFloat(int columnIndex) - throws ResultSetException-
ResultSetgetFloat in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic float getFloat(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetFloat in interface ResultSetcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateFloat(int columnIndex, - float value) - throws ResultSetException-
ResultSetupdateFloat in interface ResultSetcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateFloat(java.lang.String columnLabel, - float value) - throws ResultSetException-
ResultSetupdateFloat in interface ResultSetcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic int getInt(int columnIndex) - throws ResultSetException-
ResultSetgetInt in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic int getInt(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetInt in interface ResultSetcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateInt(int columnIndex, - int value) - throws ResultSetException-
ResultSetupdateInt in interface ResultSetcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateInt(java.lang.String columnLabel, - int value) - throws ResultSetException-
ResultSetupdateInt in interface ResultSetcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic long getLong(int columnIndex) - throws ResultSetException-
ResultSetgetLong in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic long getLong(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetLong in interface ResultSetcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateLong(int columnIndex, - long value) - throws ResultSetException-
ResultSetupdateLong in interface ResultSetcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateLong(java.lang.String columnLabel, - long value) - throws ResultSetException-
ResultSetupdateLong in interface ResultSetcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.lang.String getString(int columnIndex) - throws ResultSetException-
ResultSetgetString in interface ResultSetcolumnIndex - The column starting at position 1ResultSetException - If a ResultSetException occurspublic java.lang.String getString(java.lang.String columnLabel) - throws ResultSetException-
ResultSetgetString in interface ResultSetcolumnLabel - the name of the column to retrieveResultSetException - If a ResultSetException occurspublic void updateString(int columnIndex, - java.lang.String value) - throws ResultSetException-
ResultSetupdateString in interface ResultSetcolumnIndex - The column starting at position 1value - The new column valueResultSetException - If a ResultSetException occurspublic void updateString(java.lang.String columnLabel, - java.lang.String value) - throws ResultSetException-
ResultSetupdateString in interface ResultSetcolumnLabel - the name of the column to setvalue - The new column valueResultSetException - If a ResultSetException occurspublic java.lang.Object getObject(int columnIndex) - throws ResultSetException-
JoinablegetObject in interface JoinablecolumnIndex - The column starting at position 0ResultSetException - If a ResultSetException occurspublic void updateObject(int columnIndex, - java.lang.Object obj) - throws ResultSetException-
JoinableupdateObject in interface JoinablecolumnIndex - The column starting at position 0obj - The new column valueResultSetException - If a ResultSetException occurspublic long getRowPosition()-
public void setRowPosition(long rowPosition)-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.model.result | -- |
| Modifier and Type | -Method and Description | -
|---|---|
Column |
-ResultSetImpl.getColumn(int columnIndex) |
-
Column |
-ResultSet.getColumn(int columnIndex)
-Gets the column associated with the columnIndex
- |
-
Column[] |
-ResultSetImpl.getColumns() |
-
Column[] |
-ResultSet.getColumns()
-Returns an array of columns associated with the result set
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-ResultSetImpl.appendColumn(Column column)
-Adds a new column to a Result Set.
- |
-
void |
-ResultSetImpl.setColumns(Column[] columns) |
-
| Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.action.join | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.result | -- |
| Modifier and Type | -Method and Description | -
|---|---|
void |
-RightOuterJoin.setJoins(Joinable... joinables) |
-
void |
-LeftOuterJoin.setJoins(Joinable... joinables) |
-
void |
-JoinAction.setJoins(Joinable... joinables)
-Sets the joinable resultSets that are to be combined and joins them.
- |
-
void |
-InnerJoin.setJoins(Joinable... joinables) |
-
void |
-FullOuterJoin.setJoins(Joinable... joinables) |
-
| Modifier and Type | -Class and Description | -
|---|---|
class |
-FileResultSet
-An implementation of a Result Set that is persistable to the file system
- |
-
class |
-MemoryResultSet
-The memory ResultSet stores a result set in JVM memory.
- |
-
class |
-ResultSetImpl
-This class provides a base implementation of ResultSets that adds basic
- functionality that can then be extended by individual implementations.
- |
-
javax.ws.rs.core.StreamingOutputcreateStream(Result result) createStream(Result result)
+| Modifier and Type | +Method and Description | +||
|---|---|---|---|
void |
+IRCTEventListener.afterGetResult(Result result)
+Runs the event listeners after a result is retrieved
+ |
||
javax.ws.rs.core.StreamingOutput |
-XMLTabularDataConverter.createStream(Result result) |
+void |
+IRCTEventListener.afterSaveResult(Result result)
+Runs the event listers after a result is saved
+ |
javax.ws.rs.core.StreamingOutput |
-ResultDataConverter.createStream(Result result)
-Returns an output stream
+ | void |
+IRCTEventListener.beforeSaveResult(Result result)
+Runs the event listers before a result is saved
|
| Modifier and Type | +Method and Description | +||
|---|---|---|---|
void |
+BeforeSaveResult.fire(Result result) |
+||
javax.ws.rs.core.StreamingOutput |
-JSONTabularDataConverter.createStream(Result result) |
+void |
+AfterSaveResult.fire(Result result) |
javax.ws.rs.core.StreamingOutput |
-CSVTabularDataConverter.createStream(Result result) |
+void |
+AfterGetResult.fire(Result result)
+An action that is run after a result is retrieved
+ |
ResultDataTypegetResultDataType() ResultDataTypegetResultDataType() ResultDataTypegetResultDataType()
ResultDataTypegetResultDataType() ResultDataTypegetResultDataType() | Package | -Description | -
|---|---|
| edu.harvard.hms.dbmi.bd2k.irct.action | -- |
| edu.harvard.hms.dbmi.bd2k.irct.action.join | -- |
| edu.harvard.hms.dbmi.bd2k.irct.action.process | -- |
| edu.harvard.hms.dbmi.bd2k.irct.action.query | -- |
| edu.harvard.hms.dbmi.bd2k.irct.controller | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.action | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.process | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.query.predicate | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.resource | -- |
| edu.harvard.hms.dbmi.bd2k.irct.model.result | -- |
| edu.harvard.hms.dbmi.bd2k.irct.util.converter | -- |
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-QueryExecutable.getResults() |
-
ResultSet |
-ProcessExecutable.getResults() |
-
ResultSet |
-JoinExecutable.getResults() |
-
ResultSet |
-ExecutionPlan.getResults()
-Return the results of the execution plan if they are available
- |
-
ResultSet |
-Executable.getResults()
-Returns the result set
- |
-
ResultSet |
-Action.getResults()
-Gets the results
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-RightOuterJoin.getResults() |
-
ResultSet |
-LeftOuterJoin.getResults() |
-
ResultSet |
-InnerJoin.getResults() |
-
ResultSet |
-FullOuterJoin.getResults() |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-ExecuteProcess.getResults() |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-ExecuteQuery.getResults() |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-ResultController.getResultSet(java.lang.Long id)
-Gets a result set from the entity manager
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-ActionState.getResults()
-Returns the result set
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-ActionState.setResults(ResultSet results)
-Sets the result set
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.util.Map<java.lang.String,ResultSet> |
-IRCTProcess.getResultSets() |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-IRCTProcess.setResultSets(java.util.Map<java.lang.String,ResultSet> resultSets) |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-PredicateImplementationInterface.run()
-Runs the predicate action and returns the computed results
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-PredicateImplementationInterface.setResultSet(ResultSet resultset)
-Sets the input result set that the predicate will be run on
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-QueryResourceImplementationInterface.getResults(ActionState actionState)
-Returns the results of the query if they are available
- |
-
ResultSet |
-ProcessResourceImplementationInterface.getResults(ActionState actionState)
-Returns the results of the process if they are available
- |
-
| Modifier and Type | -Class and Description | -
|---|---|
class |
-FileResultSet
-An implementation of a Result Set that is persistable to the file system
- |
-
class |
-MemoryResultSet
-The memory ResultSet stores a result set in JVM memory.
- |
-
class |
-ResultSetImpl
-This class provides a base implementation of ResultSets that adds basic
- functionality that can then be extended by individual implementations.
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-Result.getImplementingResultSet()
-Returns an instantiation of a class that implements the result status
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
void |
-Result.setImplementingResultSet(ResultSet implementingResultSet)
-Sets the class that is used to implement the result status
- |
-
| Modifier and Type | -Method and Description | -
|---|---|
ResultSet |
-ResultSetConverter.convertToEntityAttribute(java.lang.String className) |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-ResultSetConverter.convertToDatabaseColumn(ResultSet resultSet) |
-
getFileListjava.util.List<java.io.File>getFileList() booleanisAvailable(java.lang.String location)
booleanisClosed()
booleanisCurrent()
booleanisPersisted()
voidload(java.lang.String location)
voidmerge()
voidpersist()
voidpersist(java.lang.String location)
voidrefresh()
voidsetArray(javax.json.JsonArray jsonArray)
voidsetObject(javax.json.JsonObject jsonObject)
public boolean isClosed()@@ -489,6 +493,19 @@
public java.util.List<java.io.File> getFileList()+
getFileList in interface Data| Class and Description | +
|---|
| Result
+ The result class is created for each execution that is run on the IRCT
+ (Query, Process, etc...).
+ |
+
| Class and Description | +
|---|
| Result
+ The result class is created for each execution that is run on the IRCT
+ (Query, Process, etc...).
+ |
+
java.util.List<java.io.File>getFileList() floatgetFloat(int columnIndex)
floatgetFloat(java.lang.String columnLabel)
intgetInt(int columnIndex)
intgetInt(java.lang.String columnLabel)
longgetLong(int columnIndex)
longgetLong(java.lang.String columnLabel)
java.lang.ObjectgetObject(int columnIndex)
longgetRow()
longgetSize()
java.lang.StringgetString(int columnIndex)
java.lang.StringgetString(java.lang.String columnLabel)
booleanisAvailable(java.lang.String location)
booleanisCurrent()
booleanisPersisted()
booleanlast()
voidload(java.lang.String fileName)
voidmerge()
booleannext()
voidpersist()
voidpersist(java.lang.String fileName)
booleanprevious()
voidrefresh()
booleanrelative(long rows)
javax.json.JsonObjecttoJson()
javax.json.JsonObjecttoJson(int depth)
voidupdateBoolean(int columnIndex,
boolean value)
voidupdateBoolean(java.lang.String columnLabel,
boolean value)
voidupdateByte(int columnIndex,
byte value)
voidupdateByte(java.lang.String columnLabel,
byte value)
voidupdateDate(int columnIndex,
java.util.Date value)
voidupdateDate(java.lang.String columnLabel,
java.util.Date value)
voidupdateDouble(int columnIndex,
double value)
voidupdateDouble(java.lang.String columnLabel,
double value)
voidupdateFloat(int columnIndex,
float value)
voidupdateFloat(java.lang.String columnLabel,
float value)
voidupdateInt(int columnIndex,
int value)
voidupdateInt(java.lang.String columnLabel,
int value)
voidupdateLong(int columnIndex,
long value)
voidupdateLong(java.lang.String columnLabel,
long value)
voidupdateObject(int columnIndex,
java.lang.Object obj)
voidupdateString(int columnIndex,
java.lang.String value)
voidupdateString(java.lang.String columnLabel,
java.lang.String value)
@@ -920,6 +924,21 @@ public java.util.List<java.io.File> getFileList()+
getFileList in interface DatagetFileList in class ResultSetImplabsolute, afterLast, appendColumn, beforeFirst, close, findColumn, first, getColumn, getColumns, getColumnSize, getRow, getRowPosition, isClosed, isFirst, isLast, last, load, next, previous, relative, setRowPosition
+absolute, afterLast, appendColumn, beforeFirst, close, findColumn, first, getColumn, getColumns, getColumnSize, getFileList, getRow, getRowPosition, isClosed, isFirst, isLast, last, load, next, previous, relative, setRowPosition
getFileListjava.util.List<java.io.File>getFileList() floatgetFloat(int columnIndex)
floatgetFloat(java.lang.String columnLabel)
intgetInt(int columnIndex)
intgetInt(java.lang.String columnLabel)
longgetLong(int columnIndex)
longgetLong(java.lang.String columnLabel)
java.lang.ObjectgetObject(int columnIndex)
longgetRow()
longgetRowPosition()
longgetSize()
java.lang.StringgetString(int columnIndex)
java.lang.StringgetString(java.lang.String columnLabel)
booleanisClosed()
booleanisFirst()
booleanisLast()
booleanlast()
voidload(java.lang.String resultSetLocation) booleannext()
booleanprevious()
booleanrelative(long rows)
voidsetRowPosition(long rowPosition)
voidupdateBoolean(int columnIndex,
boolean value)
voidupdateBoolean(java.lang.String columnLabel,
boolean value)
voidupdateByte(int columnIndex,
byte value)
voidupdateByte(java.lang.String columnLabel,
byte value)
voidupdateDate(int columnIndex,
java.util.Date value)
voidupdateDate(java.lang.String columnLabel,
java.util.Date value)
voidupdateDouble(int columnIndex,
double value)
voidupdateDouble(java.lang.String columnLabel,
double value)
voidupdateFloat(int columnIndex,
float value)
voidupdateFloat(java.lang.String columnLabel,
float value)
voidupdateInt(int columnIndex,
int value)
voidupdateInt(java.lang.String columnLabel,
int value)
voidupdateLong(int columnIndex,
long value)
voidupdateLong(java.lang.String columnLabel,
long value)
voidupdateObject(int columnIndex,
java.lang.Object obj)
voidupdateString(int columnIndex,
java.lang.String value)
voidupdateString(java.lang.String columnLabel,
java.lang.String value)
@@ -600,6 +604,19 @@ public java.util.List<java.io.File> getFileList()+
getFileList in interface Datajava.util.List<Entity>searchForOntology(Resource resource,
- Entity resourcePath,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-java.util.List<Entity>searchForTerm(Resource resource,
+PathController.searchForTerm(Resource resource,
Entity resourcePath,
- java.lang.String searchTerm,
+ FindInformationInterface findInformation,
SecureSession session)
Searches a resource for a given searchTerm.
java.util.List<Entity>traversePath(Resource resource,
Entity resourcePath,
@@ -235,6 +237,204 @@ Uses of
+
+
+Uses of SecureSession in edu.harvard.hms.dbmi.bd2k.irct.event
+
+Methods in edu.harvard.hms.dbmi.bd2k.irct.event with parameters of type SecureSession
+
+Modifier and Type
+Method and Description
+
+
+
+voidIRCTEventListener.afterAction(SecureSession session,
+ Action action)
+Runs the event listeners after an action is run
+
+
+
+voidIRCTEventListener.afterExecutionPlan(SecureSession session,
+ Executable executable)
+Runs the event listeners after an execution plan is run
+
+
+
+voidIRCTEventListener.afterFind(java.util.List<Entity> matches,
+ FindInformationInterface findInformation,
+ SecureSession session)
+Runs the listeners after a find is executed
+
+
+
+voidIRCTEventListener.afterJoin(SecureSession session,
+ IRCTJoin joinType)
+Runs the event listeners after a join is run
+
+
+
+voidIRCTEventListener.afterProcess(SecureSession session,
+ IRCTProcess process)
+Runs the event listeners after a process is run
+
+
+
+voidIRCTEventListener.afterQuery(SecureSession session,
+ Resource resource,
+ Query query)
+Runs the event listeners after a query is run
+
+
+
+voidIRCTEventListener.beforeAction(SecureSession session,
+ Action action)
+Runs the event listeners before an action is run
+
+
+
+voidIRCTEventListener.beforeExecutionPlan(SecureSession session,
+ Executable executable)
+Runs the event listener before an execution plan is run
+
+
+
+voidIRCTEventListener.beforeFind(Resource resource,
+ Entity resourcePath,
+ java.util.List<FindInformationInterface> findInformation,
+ SecureSession session)
+Runs the event listeners before a find is executed
+
+
+
+voidIRCTEventListener.beforeJoin(SecureSession session,
+ IRCTJoin joinType)
+Runs the event listeners before a join is run
+
+
+
+voidIRCTEventListener.beforeProcess(SecureSession session,
+ IRCTProcess process)
+Runs the event listeners before a process is run
+
+
+
+voidIRCTEventListener.beforeQuery(SecureSession session,
+ Resource resource,
+ Query query)
+Runs the event listeners before a query is run
+
+
+
+
+
+-
+
+
+
Uses of SecureSession in edu.harvard.hms.dbmi.bd2k.irct.event.action
+
+Methods in edu.harvard.hms.dbmi.bd2k.irct.event.action with parameters of type SecureSession
+
+Modifier and Type
+Method and Description
+
+
+
+voidBeforeAction.fire(SecureSession session,
+ Action action)
+
+
+voidAfterAction.fire(SecureSession session,
+ Action action)
+
+
+voidBeforeExecutionPlan.fire(SecureSession session,
+ Executable executable)
+
+
+voidAfterExecutionPlan.fire(SecureSession session,
+ Executable executable)
+An action that is run after an execution plan is completed
+
+
+
+voidBeforeJoin.fire(SecureSession session,
+ IRCTJoin joinType)
+
+
+voidAfterJoin.fire(SecureSession session,
+ IRCTJoin joinType)
+
+
+voidBeforeProcess.fire(SecureSession session,
+ IRCTProcess process)
+
+
+voidAfterProcess.fire(SecureSession session,
+ IRCTProcess process)
+
+
+voidBeforeQuery.fire(SecureSession session,
+ Resource resource,
+ Query query)
+
+
+voidAfterQuery.fire(SecureSession session,
+ Resource resource,
+ Query query)
+
+
+
+
+-
+
+
+
Uses of SecureSession in edu.harvard.hms.dbmi.bd2k.irct.event.find
+
+Methods in edu.harvard.hms.dbmi.bd2k.irct.event.find with parameters of type SecureSession
+
+Modifier and Type
+Method and Description
+
+
+
+voidAfterFind.fire(java.util.List<Entity> matches,
+ FindInformationInterface findInformation,
+ SecureSession session)
+
+
+voidBeforeFind.fire(Resource resource,
+ Entity resourcePath,
+ java.util.List<FindInformationInterface> findInformation,
+ SecureSession session)
+
+
+
+
-
@@ -281,27 +481,35 @@
Uses of
java.util.List<Entity>PathResourceImplementationInterface.find(Entity path,
+ FindInformationInterface findInformation,
+ SecureSession session)
+Given a path find all entities that match the finds
+
+
java.util.List<Entity>getPathRelationship(Entity path,
OntologyRelationship relationship,
SecureSession session)
ResultgetResults(SecureSession session,
Result result)
ResultgetResults(SecureSession session,
Result result)
ResultrunProcess(SecureSession session,
IRCTProcess process,
@@ -309,7 +517,7 @@ Uses of Run the given process
ResultrunQuery(SecureSession session,
Query qep,
@@ -317,24 +525,6 @@ Uses of Runs the given query
java.util.List<Entity>searchOntology(Entity path,
- java.lang.String ontologyType,
- java.lang.String ontologyTerm,
- SecureSession session)
-java.util.List<Entity>searchPaths(Entity path,
- java.lang.String searchTerm,
- SecureSession session)
-| Modifier and Type | +Method and Description | +
|---|---|
void |
+IRCTEventListener.beforeGetResult(User user,
+ java.lang.Long resultId)
+Runs the event listeners before a result is retrieved
+ |
+
| Modifier and Type | +Method and Description | +
|---|---|
void |
+BeforeGetResult.fire(User user,
+ java.lang.Long resultId) |
+
| Class and Description | +
|---|
| SecureSession
+ A secure session contains information about a user, the token associated with
+ that user, and the unique key generated for that combination.
+ |
+
| User
+ A basic user representation.
+ |
+
| Class and Description | +
|---|
| SecureSession
+ A secure session contains information about a user, the token associated with
+ that user, and the unique key generated for that combination.
+ |
+
| Class and Description | +
|---|
| SecureSession
+ A secure session contains information about a user, the token associated with
+ that user, and the unique key generated for that combination.
+ |
+
| Class and Description | +
|---|
| User
+ A basic user representation.
+ |
+
public class JsonUtilities
-extends java.lang.Object
-| Constructor and Description | -
|---|
JsonUtilities() |
-
| Modifier and Type | -Method and Description | -
|---|---|
static javax.json.JsonObject |
-mapToJson(java.util.Map map)
-Given a map returns a JSON object with attributes where the attribute
- name is the string value of the map key, and the attribute value is the
- string value of map value.
- |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static javax.json.JsonObject mapToJson(java.util.Map map)-
map - Map to turn into JSONpublic class Utilities
extends java.lang.Object
-static PathtraversePath(Path currentPosition,
- java.lang.String[] components)
-static IRCTEventListenergetIRCTEventListener() public static Path traversePath(Path currentPosition, - java.lang.String[] components)-
currentPosition - Current positioncomponents - Componentspublic static IRCTEventListener getIRCTEventListener()
public class ResultSetConverter -extends java.lang.Object -implements javax.persistence.AttributeConverter<ResultSet,java.lang.String>-
| Constructor and Description | -
|---|
ResultSetConverter() |
-
| Modifier and Type | -Method and Description | -
|---|---|
java.lang.String |
-convertToDatabaseColumn(ResultSet resultSet) |
-
ResultSet |
-convertToEntityAttribute(java.lang.String className) |
-
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitlong id+
java.lang.String name+
java.util.Map<K,V> parameters+
IRCTEvent eventListener+
java.util.List<E> resources+
java.util.Set<E> resources
java.util.List<E> supportedVisualizations-
java.util.Map<K,V> parameters
boolean setup+