|
Enterprise Information Portal APIs |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.mm.sdk.common.DKQSubExpr
A sub-query DKQSubExpr expression consists of entity-names, a display-list, a query term, an option list, and an optional parameter list. A query expression DKQExpr may contains one or more sub-expressions, each sub-expression essentially defines a sub-query. When the query is executed, each sub-query will be executed and the results will be OR-ed together to form a result for the whole query. Digital Library datastore supports sub-queries as described above, but not all datastores support sub-queries. In such a case, there will bw only one sub-query.
Constructor Summary | |
DKQSubExpr()
Default constructor without a parameter. |
Method Summary | |
java.lang.String |
getAssociatedEntityName()
Gets the associated entity name associated with this query This entity will support text and parametric query |
java.lang.String[] |
getDisplayList()
Gets the display-list in this query. |
java.lang.String |
getEntityName()
Gets the entity-name specified in this query. |
java.lang.String[] |
getEntityNames()
Gets the entity-names in this query; there are more than one entity-names. |
java.lang.String |
getMappingName()
Gets the optional schema mapping name for executing this query. |
int |
getMappingType()
Gets the optional schema mapping type for executing this query. |
DKNVPair |
getOption(int position)
Gets an option at the given position. |
DKNVPair |
getOption(java.lang.String name)
Gets an option with a given name. |
DKNVPair[] |
getOptionList()
|
DKNVPair |
getParameter(int position)
Gets a parameter at a given position. |
DKNVPair |
getParameter(java.lang.String name)
Gets a parameter with a given name. |
DKNVPair[] |
getParameterList()
|
DKQTerm |
getQueryTerm()
Gets the query term or condition part of this query. |
boolean |
isTranslation()
Check if this query requires schema translation using schema mapping. |
int |
optionCount()
Gets the number of defined options. |
int |
parameterCount()
Gets the number of defined parameters. |
void |
removeOption(int position)
Removes the option at the given position. |
int |
removeOption(java.lang.String name)
Removes the option with the given name. |
void |
removeParameter(int position)
Removes the parameter at the given position. |
int |
removeParameter(java.lang.String name)
Removes the parameter with the given name. |
void |
setAssociatedEntityName(java.lang.String assocEntityName)
Sets the associated entity name associated with this query This entity will support text and parametric query |
void |
setDisplayList(java.lang.String[] names)
Sets the display-list in this query. |
void |
setEntityName(java.lang.String name)
Sets the entity-name in this query. |
void |
setEntityNames(java.lang.String[] names)
Sets the entity-names in this query; there are more than one entity-names. |
void |
setMappingName(java.lang.String mappingName)
Sets the optional schema mapping name for executing this query. |
void |
setMappingType(int mappingType)
Sets the optional schema mapping type for executing this query. |
void |
setOption(int position,
DKNVPair optionPair)
Sets the option at the given position. |
int |
setOption(java.lang.String name,
java.lang.Object value)
Sets the option with the given name. |
void |
setOptionList(DKNVPair[] optionList)
|
void |
setParameter(int position,
DKNVPair parmPair)
Sets the parameter at the given position. |
int |
setParameter(java.lang.String name,
java.lang.Object value)
Sets a parameter with a given name. |
void |
setParameterList(DKNVPair[] parameterList)
|
void |
setQueryTerm(DKQTerm qTerm)
Sets the query term or condition part in this query. |
void |
setTranslation(boolean translation)
Sets the requirement for schema translation for this query. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DKQSubExpr()
Method Detail |
public java.lang.String getEntityName()
public void setEntityName(java.lang.String name)
the
- entity name.public java.lang.String getAssociatedEntityName()
public void setAssociatedEntityName(java.lang.String assocEntityName)
assocEntityName
- associated entity namepublic java.lang.String[] getEntityNames()
public void setEntityNames(java.lang.String[] names)
values
- a string array of entity names.public java.lang.String getMappingName()
public void setMappingName(java.lang.String mappingName)
mappingName
- the mapping namepublic int getMappingType()
public void setMappingType(int mappingType)
mappingName
- the mapping namegetMappingType()
public boolean isTranslation()
public void setTranslation(boolean translation)
setMappingName()
method.translation
- true or false.isTranslation()
,
setMappingName(java.lang.String)
public java.lang.String[] getDisplayList()
public void setDisplayList(java.lang.String[] names)
names
- a string array of attribute-names.getDisplayList()
public DKQTerm getQueryTerm()
public void setQueryTerm(DKQTerm qTerm)
a
- DKQTerm objectpublic int optionCount()
public DKNVPair[] getOptionList()
public void setOptionList(DKNVPair[] optionList)
public DKNVPair getOption(int position)
java.lang.IndexOutOfBoundsException
- if position is invalid.public DKNVPair getOption(java.lang.String name)
public void setOption(int position, DKNVPair optionPair)
optionPair
- the new optionjava.lang.IndexOutOfBoundsException
- if position is invalid.public int setOption(java.lang.String name, java.lang.Object value)
public void removeOption(int position)
the
- position.java.lang.IndexOutOfBoundsException
- if position is invalid.public int removeOption(java.lang.String name)
name
- the option name.java.lang.IndexOutOfBoundsException
- if position is invalid.public int parameterCount()
public DKNVPair[] getParameterList()
public void setParameterList(DKNVPair[] parameterList)
public DKNVPair getParameter(int position)
java.lang.IndexOutOfBoundsException
- if position is invalid.public DKNVPair getParameter(java.lang.String name)
public void setParameter(int position, DKNVPair parmPair)
parmPair
- the new parameterjava.lang.IndexOutOfBoundsException
- if position is invalid.public int setParameter(java.lang.String name, java.lang.Object value)
public void removeParameter(int position)
the
- position.java.lang.IndexOutOfBoundsException
- if position is invalid.public int removeParameter(java.lang.String name)
name
- the parameter name.java.lang.IndexOutOfBoundsException
- if position is invalid.
|
EIP Java APIs | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |