EDMQuery

edm.edom3

Interface EDMQuery

• All Superinterfaces:EDMContextDependent, EDMWorker

  ---

  
  

  public interface EDMQuery
  extends EDMWorker

  
  This worker implements running query functions in query schemata.

• • Method Summary

    All Methods Instance Methods Abstract Methods 

    Modifier and Type	Method and Description
    EDMExpressSchema	getForSchema() Retrieve the EXPRESS schema for this query.
    java.lang.String	getQueryFunctionName() Get query function name given for this query
    java.lang.String	getQuerySchemaName() Get query schema name given for this query
    long	getResultType() Get result type
    void	setForSchema(EDMExpressSchema schema) Set the EXPRESS schema for this query.
    void	setQueryFunctionName(java.lang.String s) Set query function name for this query
    void	setQuerySchemaName(java.lang.String s) Set query schema name to use for this query
    void	setResultType(long type) Assign result type.

    • Methods inherited from interface edm.edom3.EDMWorker

      execute, getConfiguration, getFileMappings, getFormalParameters, getHitsOut, getIndexOut, getLogDescription, getOptions, getParameters, getResult, getSource, getTarget, resetOptions, setConfiguration, setFileMappings, setOptions, setParameters, setSource, setSystemOutput, setSystemOutput, setTarget, setUserOutput, setUserOutput

    • Methods inherited from interface edm.edom3.EDMContextDependent

      getContext

• • Method Detail

    • getForSchema

      EDMExpressSchema getForSchema()
                             throws EdmiException

      
      Retrieve the EXPRESS schema for this query. It can only be retrieved if the data source for this query is set.

      Returns:EXPRESS schema wrapper.Throws:EdmiException - if the method fails

    • setForSchema

      void setForSchema(EDMExpressSchema schema)
                 throws EdmiException

      
      Set the EXPRESS schema for this query. If the query source refers to another schema the latter will take precedence. Usually this method is superfluous as forSchema is given implicitly by the source model.

      Parameters:schema - EDMExpressSchemato be setThrows:EdmiException - if the method fails

    • getQuerySchemaName

      java.lang.String getQuerySchemaName()

      
      Get query schema name given for this query

      Returns:query schema name

    • setQuerySchemaName

      void setQuerySchemaName(java.lang.String s)

      
      Set query schema name to use for this query

      Parameters:s - query schema name

    • getQueryFunctionName

      java.lang.String getQueryFunctionName()

      
      Get query function name given for this query

      Returns:query function name

    • setQueryFunctionName

      void setQueryFunctionName(java.lang.String s)

      
      Set query function name for this query

      Parameters:s - query function name

    • setResultType

      void setResultType(long type)

      
      Assign result type.

      Parameters:type - : RESULT_AS_VALUE -> the method will return a SELECT value. RESULT_AS_MATRIX -> the method will return null and other methods (cell/row/column/matrix) should be used to obtain the query result after invocation of this method.See Also:EDMConstants.QueryOptions

    • getResultType

      long getResultType()

      
      Get result type

      Returns:result type.