Class AbstractStoredProcedureQuery

java.lang.Object
org.datanucleus.store.query.Query
org.datanucleus.store.query.AbstractStoredProcedureQuery
All Implemented Interfaces:
Serializable, ExecutionContextListener

public abstract class AbstractStoredProcedureQuery extends Query
Abstract representation of a stored procedure query.
See Also:
  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:
    • procedureName

      protected String procedureName
    • storedProcParams

    • resultSetNumber

      protected int resultSetNumber
    • resultMetaDatas

      protected QueryResultMetaData[] resultMetaDatas
      MetaData defining the results of the query (optional).
    • resultClasses

      protected Class[] resultClasses
      Result classes for the result sets (optional).
    • outputParamValues

      protected Map<Object,Object> outputParamValues
      Repository for holding output parameter values after execution.
  • Constructor Details

    • AbstractStoredProcedureQuery

      public AbstractStoredProcedureQuery(StoreManager storeMgr, ExecutionContext ec, AbstractStoredProcedureQuery query)
      Constructs a new query instance from the existing query.
      Parameters:
      storeMgr - StoreManager for this query
      ec - ExecutionContext
      query - Existing query
    • AbstractStoredProcedureQuery

      public AbstractStoredProcedureQuery(StoreManager storeMgr, ExecutionContext ec, String procName)
      Constructs a new query instance having the same criteria as the given query.
      Parameters:
      storeMgr - StoreManager for this query
      ec - The ExecutionContext
      procName - Name of the stored procedure in the datastore
  • Method Details

    • getLanguage

      public String getLanguage()
      Description copied from class: Query
      Accessor for the query language.
      Overrides:
      getLanguage in class Query
      Returns:
      Query language
    • setCandidates

      public void setCandidates(Extent pcs)
      Description copied from class: Query
      Set the candidate Extent to query. To be implemented by extensions.
      Specified by:
      setCandidates in class Query
      Parameters:
      pcs - the Candidate Extent.
    • setCandidates

      public void setCandidates(Collection pcs)
      Description copied from class: Query
      Set the candidate Collection to query. To be implemented by extensions.
      Specified by:
      setCandidates in class Query
      Parameters:
      pcs - the Candidate collection.
    • setResultMetaData

      public void setResultMetaData(QueryResultMetaData[] qrmds)
      Method to set the MetaData defining the result. Setting this will unset the resultClass.
      Parameters:
      qrmds - Query Result MetaData
    • setResultClasses

      public void setResultClasses(Class[] resultClasses)
      Set the result class for the results. Setting this will unset the resultMetaData.
      Parameters:
      resultClasses - The result class
    • registerParameter

      public void registerParameter(int pos, Class type, StoredProcQueryParameterMode mode)
    • registerParameter

      public void registerParameter(String name, Class type, StoredProcQueryParameterMode mode)
    • hasMoreResults

      public abstract boolean hasMoreResults()
      Accessor for whether there are more results after the current one.
      Returns:
      Whether there are more results
    • getNextResults

      public abstract Object getNextResults()
      Accessor for the next result set.
      Returns:
      Next results
    • getUpdateCount

      public abstract int getUpdateCount()
      Accessor for the update count.
      Returns:
      Update count
    • getOutputParameterValue

      public Object getOutputParameterValue(int pos)
      Accessor for the value of the output parameter at the specified position. Only to be called after execute().
      Parameters:
      pos - Position
      Returns:
      The value
    • getOutputParameterValue

      public Object getOutputParameterValue(String name)
      Accessor for the value of the output parameter with the specified name. Only to be called after execute().
      Parameters:
      name - Name of the parameter
      Returns:
      The value