Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKCQExpr

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKCQExpr
All Implemented Interfaces:
java.io.Serializable

public class DKCQExpr
extends java.lang.Object
implements java.io.Serializable

DKCQExpr class represents a compound or combined query expression. It may contain a DKQExpr query expressions tree, which may contains a combination of one parametric, one text, and one image query.

See Also:
Serialized Form

Constructor Summary
DKCQExpr()
          Default constructor without a parameter.
DKCQExpr(DKQExpr queryExpr)
          Constructor with one query expression.
 
Method Summary
 java.lang.String getDatastoreName()
          Gets the target datastore name for executing this query.
 java.lang.String getDatastoreType()
          Gets the target datastore type for executing this query.
 java.lang.String[] getEntityNames()
          Gets the mapped entity names in this query expression.
 java.lang.String[] getMappingNames()
          Gets the optional schema mapping names for executing this query.
 int[] getMappingTypes()
          Gets the optional schema mapping types for executing this query.
 short getQLType()
          Gets the query language type, which could be a parametric, text, image query, combined query, etc.
 DKQExpr getQueryExpr()
          Gets the query expression.
 java.lang.String getSearchTemplateName()
          Gets the search template name origin of this query expression.
 boolean isTranslation()
          Check if this query requires schema translation using schema mapping.
 void setDatastoreName(java.lang.String dsName)
          Sets the target datastore name for executing this query.
 void setDatastoreType(java.lang.String dsType)
          Sets the target datastore type for executing this query.
 void setQLType(short qlType)
          Sets the query language type.
 void setQueryExpr(DKQExpr queryExpr)
          Sets the query expression tree.
 void setSearchTemplateName(java.lang.String stName)
          Sets the search template name origin of this query expression.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKCQExpr

public DKCQExpr()
Default constructor without a parameter.

DKCQExpr

public DKCQExpr(DKQExpr queryExpr)
Constructor with one query expression.
Method Detail

getQLType

public short getQLType()
Gets the query language type, which could be a parametric, text, image query, combined query, etc.
Returns:
the query language type.

setQLType

public void setQLType(short qlType)
Sets the query language type.
Parameters:
qlType - the query language type
See Also:
getQLType()

getDatastoreType

public java.lang.String getDatastoreType()
Gets the target datastore type for executing this query.
Returns:
target datastore type

setDatastoreType

public void setDatastoreType(java.lang.String dsType)
Sets the target datastore type for executing this query.
Parameters:
dsName - target datastore type

getDatastoreName

public java.lang.String getDatastoreName()
Gets the target datastore name for executing this query.
Returns:
target datastore name

setDatastoreName

public void setDatastoreName(java.lang.String dsName)
Sets the target datastore name for executing this query.
Parameters:
dsName - target datastore name

getSearchTemplateName

public java.lang.String getSearchTemplateName()
Gets the search template name origin of this query expression. This data member is only applicable for query expressions originated from search templates.
Returns:
search template name

setSearchTemplateName

public void setSearchTemplateName(java.lang.String stName)
Sets the search template name origin of this query expression. This data member is only applicable for query expressions originated from search templates.
Parameters:
stName - the search template name

getMappingNames

public java.lang.String[] getMappingNames()
                                   throws DKException
Gets the optional schema mapping names for executing this query. The default value is null, which means mapping is not required.
Returns:
an array of mapping names.

getMappingTypes

public int[] getMappingTypes()
                      throws DKException
Gets the optional schema mapping types for executing this query. The default value is 0, which means mapping is not required. Valid types are: DK_FED_MAPPED_ENTITY, DK_FED_MAPPED_TEXT_ENTITY, etc
Returns:
an array of mapping types.

getEntityNames

public java.lang.String[] getEntityNames()
                                  throws DKException
Gets the mapped entity names in this query expression.
Returns:
the array of mapped entity names.

isTranslation

public boolean isTranslation()
Check if this query requires schema translation using schema mapping.
Returns:
true if schema translation is required.

getQueryExpr

public DKQExpr getQueryExpr()
Gets the query expression. It could be a tree of DKQExpr query expressions connected by logical operator AND or OR.
Returns:
a query expression tree

setQueryExpr

public void setQueryExpr(DKQExpr queryExpr)
Sets the query expression tree.
Parameters:
queryExpr - a query expression tree
See Also:
getQueryExpr()

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.