PreparedSelectorGenerator (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.core.util.PreparedSelectorGenerator

Direct Known Subclasses:

SportsOperations.CustomPreparedSelectorGenerator, SportsPreparedSelectorGenerator
```
public class PreparedSelectorGenerator
extends Object
```
Validates and generates search and sort clauses of a query specification executed by a PreparedSelector.

Author:

Dave Long

(Published)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`PreparedSelectorGenerator.FunctionMethodMap` A FunctionMethodMap encapsulates a table of function methods, keyed by function name.
`class`	`PreparedSelectorGenerator.SelectorFunction` A SelectorFunction holds information about an embedded function in the search or sort conditions.

Field Summary

Fields
Modifier and Type Field and Description

protected static String CONTEXT_DOCUMENT_VIEW_NAME
The name of the view used in full-text searches on DOCUMENT.

Fields
Modifier and Type	Field and Description
`protected static String`	`CONTEXT_DOCUMENT_VIEW_NAME` The name of the view used in full-text searches on DOCUMENT.

Constructor Summary

Constructors
Constructor and Description

PreparedSelectorGenerator()
Constructs a PreparedSelectorGenerator.

Constructors
Constructor and Description
`PreparedSelectorGenerator()` Constructs a PreparedSelectorGenerator.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAuxiliarySearchTarget(AttributeValue target)` Adds an Auxiliary search target.
`void`	`addAuxiliarySearchTarget(String className, String alias)` Adds an Auxiliary search target, from the specified class name and alias.
`void`	`addAuxiliarySearchTarget(String className, String alias, String viewName)` Adds an Auxiliary search target, from the specified class name, alias, and view.
`void`	`addBindValue(AttributeValue bindValue)` Adds a bind value.
`void`	`addBypassSecurityAlias(String alias)` Adds an alias that indicates the matching search target should not have the security clause applied.
`void`	`addColumnDescriptor(ColumnDescriptor colDesc)` Adds a Column descriptor.
`String`	`ARRAY_ATTR_CONTAINS_ALL(String input)` Generates a array attribute qualification clause from a specified attribute and a set of values, resulting in a match if the array value contains all of the specified values.
`String`	`ARRAY_ATTR_CONTAINS_ANY(String input)` Generates a array attribute qualification clause from a specified attribute and a set of values, resulting in a match if the array value contains any of the specified values.
`String`	`ARRAY_ATTR_CONTAINS(String input)` Generates a array attribute qualification clause from a specified attribute and value.
`String`	`ATTR(String input)` Translates an attribute specification into a column specification.
`String`	`AUDIT_TABLENAME(String input)` Translates an AuditSpecification name into the table name used for that Audit history.
`String`	`AUDIT_VIEWNAME(String input)` Translates an AuditSpecification name into the view name used for that Audit history.
`String`	`CATEGORY_JOIN(String input)` Generates a join clause between two targets, one being a category target.
`String`	`CLASS_TABLENAME(String input)` Translates a ClassObject name into a table name.
`String`	`CLASS_VIEWNAME(String input)` Translates a ClassObject name into a view name.
`protected long[]`	`computeDateValueRange(Long dateValue, String granularity)` Compute a low/high value range for the specified numeric date value, using the specified granularity.
`protected String`	`concatTokenList(List list)` Concatenate a list of tokens, comprised of literal strings and functions.
`String`	`CONTAINS_SCORE(String input)` Adds the SQL referencing the "Contains" score as a column in a search or sort condition.
`String`	`CONTAINS_WORD(String input)` Generates a word-boundary LIKE qualification.
`String`	`CONTAINS(String input)` Adds a clause that restricts results according to a full text search qualification.
`String`	`CONTENT_SCORE(String input)` Adds the SQL referencing the content score as a column in a search or sort condition.
`String`	`CONTENT_SIZE(String input)` Adds the SQL referencing the content size as a column in a search or sort condition.
`static AttributeValue`	`createSearchTarget(String targetToken)` Create a search target specification.
`String`	`DATE_COMPARE(String input)` Generates a date comparison clause from a specified attribute, a logical operator, a date value, and a granularity value.
`String`	`DATE_VALUE_NOW(String input)` Generates a numeric value representing the current time.
`void`	`declareInnerSearchTarget(String input)` Deprecated. 9.3.3.0 use SEARCH_RESULT macro
`void`	`define(LibrarySession session, AttributeValue primaryTarget, AttributeValue[] auxTargets, String searchCondition, String sortCondition, AttributeValue[] bindValues)` Defines a PreparedSelectorGenerator.
`void`	`define(LibrarySession session, AttributeValue primaryTarget, AttributeValue[] auxTargets, String searchCondition, String sortCondition, AttributeValue[] bindValues, Boolean useExistsClause)` Defines a PreparedSelectorGenerator.
`void`	`define(LibrarySession session, AttributeValue primaryTarget, AttributeValue[] auxTargets, String joinCondition, String searchCondition, String sortCondition, AttributeValue[] bindValues)` Defines a PreparedSelectorGenerator.
`void`	`define(LibrarySession session, AttributeValue primaryTarget, AttributeValue[] auxTargets, String joinCondition, String searchCondition, String sortCondition, AttributeValue[] bindValues, Boolean useExistsClause)` Defines a PreparedSelectorGenerator.
`void`	`define(LibrarySession session, AttributeValue primaryTarget, AttributeValue[] auxTargets, String joinCondition, String searchCondition, String sortCondition, AttributeValue[] bindValues, Boolean useExistsClause, ColumnDescriptor[] colDescs)` Defines a PreparedSelectorGenerator.
`void`	`define(LibrarySession session, AttributeValue primaryTarget, AttributeValue[] auxTargets, String joinCondition, String searchCondition, String sortCondition, AttributeValue[] bindValues, Boolean useExistsClause, ColumnDescriptor[] colDescs, String[] bypassSecAliases)` Defines a PreparedSelectorGenerator.
`String`	`DOES_NOT_CONTAIN_WORD(String input)` Generates a word-boundary NOT LIKE qualification.
`String`	`EXACT_TYPE(String input)` Adds a qualification that requires an exact type match.
`String`	`EXISTS(String input)` Adds a qualification for a simple "exists" specification.
`protected Attribute`	`findAttributeByAuxName(LibrarySession session, ClassObject co, String attrName)` Lookup an Attribute using an auxilliary name.
`protected ClassObject`	`findClassObjectByAuxName(LibrarySession session, String className)` Find a ClassObject using an auxilliary name.
`protected int`	`findFunctionEnd(String input, int lcurlyPos)` Find the closing right curly that marks the end of the function, given a string and the position of the left curly.
`protected int`	`findFunctionStart(String input, int lcurlyPos)` Find the start of the function, given a string and the position of the left curly.
`protected String`	`getAliasFromTarget(AttributeValue target)` Returns the alias name from the specified search target.
`AttributeValue[]`	`getAuxiliarySearchTargets()` Returns the auxiliary search targets.
`AttributeValue[]`	`getBindValues()` Returns the bind values.
`String[]`	`getBypassSecurityAliases()` Returns the bypass security aliases.
`protected String`	`getClassFromTarget(AttributeValue target)` Deprecated. 9.3.3.0 use `getClassNameFromTarget`
`protected String`	`getClassNameFromAlias(String alias)` Deprecated. 9.3.3.0 use `getClassObjectFromAlias`.
`protected String`	`getClassNameFromTarget(AttributeValue target)` Returns the class name from the specified search target.
`protected ClassObject`	`getClassObjectFromAlias(String alias)` Returns the ClassObject associated with the specified registered alias.
`protected ClassObject`	`getClassObjectFromTarget(AttributeValue target)` Returns the class object from the specified search target.
`ColumnDescriptor[]`	`getColumnDescriptors()` Returns the Column descriptors.
`protected Method`	`getFunctionMethod(String key)` Gets the method to use for resolving the specified function.
`String`	`getJoinClause()` Returns the join clause used to specify the joins in a PreparedSelector.
`String`	`getJoinCondition()` Gets the raw join condition.
`AttributeValue[]`	`getOriginalAuxiliarySearchTargets()` Returns the original auxiliary search targets, specified when defined.
`AttributeValue`	`getOriginalPrimarySearchTarget()` Returns the original primary search target, specified when defined.
`PreparedSelector`	`getPreparedSelector()` Gets the generated PreparedSelector.
`AttributeValue`	`getPrimarySearchTarget()` Returns the primary search target.
`String`	`getSearchCondition()` Gets the raw search condition.
`protected String`	`getSearchTargetSqlFromAlias(String alias)` Generates the SQL for a search target, identified by registered alias.
`LibrarySession`	`getSession()` Gets the session context used by this instance.
`String`	`getSortClause()` Returns the Sort Clause.
`String`	`getSortCondition()` Gets the raw sort condition.
`Boolean`	`getUseExistsClause()` Returns the explicit "Use exists clause" setting.
`String`	`getWhereClause()` Returns the "where Clause" used as the search condition in a PreparedSelector.
`String`	`IN_FOLDER(String input)` Generates the clause that restricts a specified alias to a particular folder.
`protected boolean`	`isNumber(String value)` Check if the input string represents a number.
`String`	`LATEST_VERSION(String input)` Adds a qualification that restricts results for only the latest version or unversioned items.
`String`	`LITERAL(String input)` A no-op function, returning the literal resolution of the input string.
`protected String`	`lookupClassNameByNickname(String nickname)` Looks up a ClassObject name by the specified class "nickname".
`protected AttributeValue`	`lookupSearchTarget(AttributeValue target)` Returns the search target from the table map matching the provided target's associated alias.
`protected AttributeValue`	`lookupSearchTarget(String alias)` Lookup a search target by registered alias.
`protected AttributeValue`	`lookupSearchTarget(String alias, boolean enforce)` Lookup a search target by registered alias.
`protected AttributeValue[]`	`lookupSearchTargets(AttributeValue[] targets)` Returns the search targets from the table map matching the provided targets associated aliases.
`String`	`LOWER(String input)` Applies a lowercasing SQL function.
`String`	`MAP_ATTR_EXISTS_WITH_ALIAS(String input)` Generates a map attribute qualification exists clause with a defined alias for the map table, and containing an arbitrary inner search clause with the map table.
`String`	`MAP_ATTR_EXISTS(String input)` Generates a map attribute qualification exists clause containing an arbitrary inner search clause with the map table.
`String`	`MAP_ATTR_KEYED_VALUE(String input)` Generates a map attribute qualification clause containing a non-null key match from a specified attribute and key value.
`protected void`	`overrideTargetViewName(String alias, String viewName)` Overrides the view name to be used with the search target identified by the alias specified.
`protected List`	`parseInput(String input)` Create a token list from an input string.
`protected Long`	`parseNumber(String value)` Return numeric equivalent of the specified string, or return null if not a number.
`String`	`PROPERTY(String input)` Generates a property qualification clause from a specified alias, property name, and property data type.
`protected void`	`registerFunctionMethods(Class genClass, String[] funcNames)` Register function methods for the specified PreparedSelectorGenerator class.
`protected AttributeValue`	`registerSearchTarget(AttributeValue searchTarget)` Registers a new search target after validation.
`protected AttributeValue`	`registerSearchTarget(String input)` Parses and registers a new search target.
`String`	`RELATION_JOIN(String input)` Generates a join clause between a left PublicObject, a right PublicObject, and a Relation that connects the two.
`String`	`SEARCH_TARGET(String input)` Registers a new search target, and generates SQL for it to appear in a "from clause".
`String`	`SECURITY_CLAUSE(String input)` Adds a security qualification for an alias.
`void`	`setAuxiliarySearchTargets(AttributeValue[] targets)` Sets the auxiliary search targets.
`void`	`setBindValues(AttributeValue[] bindValues)` Sets the bind values.
`void`	`setBypassSecurityAliases(String[] bypassSecAliases)` Sets the aliases that indicates which PO classes should not have the security clause applied.
`void`	`setColumnDescriptors(ColumnDescriptor[] colDescs)` Sets the Column descriptors.
`void`	`setJoinCondition(String joinCondition)` Sets the join condition.
`void`	`setPrimarySearchTarget(AttributeValue target)` Sets the primary search target.
`void`	`setPrimarySearchTarget(String className, String alias)` Sets the primary search target, from the specified class name and alias.
`void`	`setPrimarySearchTarget(String className, String alias, String viewName)` Sets the primary search target, from the specified class name, alias, and view.
`void`	`setSession(LibrarySession session)` Sets the session context.
`void`	`setSortCondition(String sortCondition)` Sets the Sort condition.
`void`	`setUseExistsClause(Boolean useExists)` Returns the explicit "Use exists clause" setting.
`void`	`setWhereCondition(String searchCondition)` Sets the WHERE clause condition.
`protected void`	`throwInvalidFunction(String funcName, String input)` Throw an exception indicating an invalid search function.
`String`	`UNDER_FOLDER(String input)` Generates the clause that restricts a specified alias to a particular folder or one of its subfolders.
`String`	`UPPER(String input)` Adds an upper function.
`void`	`validate()` Validate the search specifications.
`protected AttributeValue`	`validateBindValue(AttributeValue bindValue)` Validate a bind value.
`protected void`	`validateJoinCondition(String joinCondition)` Validate the join condition.
`protected void`	`validateSearchCondition(String search)` Validate the search condition.
`protected AttributeValue`	`validateSearchTarget(AttributeValue target)` Validate a search target, and registers it if it is valid.
`protected void`	`validateSortCondition(String sort)` Validate the sort condition.
`protected void`	`verifyDocumentTarget(String alias)` Verify that the class name in the search target identified by the alias specified is DOCUMENT.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CONTEXT_DOCUMENT_VIEW_NAME
```
protected static final String CONTEXT_DOCUMENT_VIEW_NAME
```
    The name of the view used in full-text searches on DOCUMENT.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PreparedSelectorGenerator
```
public PreparedSelectorGenerator()
```
    Constructs a PreparedSelectorGenerator.
    
    (Published)
- Method Detail
  - registerFunctionMethods
```
protected void registerFunctionMethods(Class genClass,
                                       String[] funcNames)
```
    Register function methods for the specified PreparedSelectorGenerator class.
    
    Parameters:
    
    genClass - the PreparedSelectorGenerator (or subclass) class
    
    funcNames - the function names
  - define
```
public void define(LibrarySession session,
                   AttributeValue primaryTarget,
                   AttributeValue[] auxTargets,
                   String searchCondition,
                   String sortCondition,
                   AttributeValue[] bindValues)
            throws IfsException
```
    Defines a PreparedSelectorGenerator.
    Delegates to the complete 10-arg variant.
    
    Parameters:
    
    session - the session context
    
    primaryTarget - the primary search target
    
    auxTargets - the auxiliary search targets
    
    searchCondition - the search selection
    
    sortCondition - the sort specification
    
    bindValues - the bind values
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - define
```
public void define(LibrarySession session,
                   AttributeValue primaryTarget,
                   AttributeValue[] auxTargets,
                   String joinCondition,
                   String searchCondition,
                   String sortCondition,
                   AttributeValue[] bindValues)
            throws IfsException
```
    Defines a PreparedSelectorGenerator.
    Delegates to the complete 10-arg variant.
    
    Parameters:
    
    session - the session context
    
    primaryTarget - the primary search target
    
    auxTargets - the auxiliary search targets
    
    joinCondition - the join condition
    
    searchCondition - the search selection
    
    sortCondition - the sort specification
    
    bindValues - the bind values
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - define
```
public void define(LibrarySession session,
                   AttributeValue primaryTarget,
                   AttributeValue[] auxTargets,
                   String searchCondition,
                   String sortCondition,
                   AttributeValue[] bindValues,
                   Boolean useExistsClause)
            throws IfsException
```
    Defines a PreparedSelectorGenerator.
    Delegates to the complete 10-arg variant.
    
    Parameters:
    
    session - the session context
    
    primaryTarget - the primary search target
    
    auxTargets - the auxiliary search targets
    
    searchCondition - the search selection
    
    sortCondition - the sort specification
    
    bindValues - the bind values
    
    useExistsClause - whether to use EXISTS syntax for UNDER_FOLDER functions
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - define
```
public void define(LibrarySession session,
                   AttributeValue primaryTarget,
                   AttributeValue[] auxTargets,
                   String joinCondition,
                   String searchCondition,
                   String sortCondition,
                   AttributeValue[] bindValues,
                   Boolean useExistsClause)
            throws IfsException
```
    Defines a PreparedSelectorGenerator.
    Delegates to the complete 10-arg variant.
    
    Parameters:
    
    session - the session context
    
    primaryTarget - the primary search target
    
    auxTargets - the auxiliary search targets
    
    joinCondition - the join condition
    
    searchCondition - the search selection
    
    sortCondition - the sort specification
    
    bindValues - the bind values
    
    useExistsClause - whether to use EXISTS syntax for UNDER_FOLDER functions
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - define
```
public void define(LibrarySession session,
                   AttributeValue primaryTarget,
                   AttributeValue[] auxTargets,
                   String joinCondition,
                   String searchCondition,
                   String sortCondition,
                   AttributeValue[] bindValues,
                   Boolean useExistsClause,
                   ColumnDescriptor[] colDescs)
            throws IfsException
```
    Defines a PreparedSelectorGenerator.
    Delegates to the complete 10-arg variant.
    
    Parameters:
    
    session - the session context
    
    primaryTarget - the primary search target
    
    auxTargets - the auxiliary search targets
    
    joinCondition - the join condition
    
    searchCondition - the search selection
    
    sortCondition - the sort specification
    
    bindValues - the bind values
    
    useExistsClause - whether to use EXISTS syntax for UNDER_FOLDER functions
    
    colDescs - the ColumnDescriptors (when using getSearchResults())
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - define
```
public void define(LibrarySession session,
                   AttributeValue primaryTarget,
                   AttributeValue[] auxTargets,
                   String joinCondition,
                   String searchCondition,
                   String sortCondition,
                   AttributeValue[] bindValues,
                   Boolean useExistsClause,
                   ColumnDescriptor[] colDescs,
                   String[] bypassSecAliases)
            throws IfsException
```
    Defines a PreparedSelectorGenerator.
    This is the complete variant.
    
    Parameters:
    
    session - the session context
    
    primaryTarget - the primary search target
    
    auxTargets - the auxiliary search targets
    
    joinCondition - the join condition
    
    searchCondition - the search selection
    
    sortCondition - the sort specification
    
    bindValues - the bind values
    
    useExistsClause - whether to use EXISTS syntax for UNDER_FOLDER functions
    
    colDescs - the ColumnDescriptors (when using getSearchResults())
    
    bypassSecAliases - the aliases that indicates bypassing security for POs
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - setSession
```
public void setSession(LibrarySession session)
```
    Sets the session context.
    
    Parameters:
    
    session - the session context
    
    (Published)
  - setPrimarySearchTarget
```
public void setPrimarySearchTarget(String className,
                                   String alias)
                            throws IfsException
```
    Sets the primary search target, from the specified class name and alias.
    
    Parameters:
    
    className - the class name
    
    alias - the alias
    
    Throws:
    
    IfsException - if operation fails.
    
    (Published)
  - setPrimarySearchTarget
```
public void setPrimarySearchTarget(String className,
                                   String alias,
                                   String viewName)
                            throws IfsException
```
    Sets the primary search target, from the specified class name, alias, and view.
    Note: the class name is usually specified as null if a view is specified.
    
    Parameters:
    
    className - the class name (should usually be null)
    
    alias - the alias
    
    viewName - the literal view or table name
    
    Throws:
    
    IfsException - if operation fails.
    
    (Published)
  - setPrimarySearchTarget
```
public void setPrimarySearchTarget(AttributeValue target)
```
    Sets the primary search target.
    
    Parameters:
    
    target - the primary search target
    
    (Published)
  - addAuxiliarySearchTarget
```
public void addAuxiliarySearchTarget(String className,
                                     String alias)
                              throws IfsException
```
    Adds an Auxiliary search target, from the specified class name and alias.
    
    Parameters:
    
    className - the class name
    
    alias - the alias
    
    Throws:
    
    IfsException - if operation fails.
    
    (Published)
  - addAuxiliarySearchTarget
```
public void addAuxiliarySearchTarget(String className,
                                     String alias,
                                     String viewName)
                              throws IfsException
```
    Adds an Auxiliary search target, from the specified class name, alias, and view.
    Note: the class name is usually specified as null if a view is specified.
    
    Parameters:
    
    className - the class name (should usually be null)
    
    alias - the alias
    
    viewName - the literal view or table name
    
    Throws:
    
    IfsException - if operation fails.
    
    (Published)
  - addAuxiliarySearchTarget
```
public void addAuxiliarySearchTarget(AttributeValue target)
```
    Adds an Auxiliary search target.
    
    Parameters:
    
    target - the search target
    
    (Published)
  - setAuxiliarySearchTargets
```
public void setAuxiliarySearchTargets(AttributeValue[] targets)
```
    Sets the auxiliary search targets.
    
    Parameters:
    
    targets - the auxiliary search targets
    
    (Published)
  - addBindValue
```
public void addBindValue(AttributeValue bindValue)
```
    Adds a bind value.
    
    Parameters:
    
    bindValue - the bind value
    
    (Published)
  - setBindValues
```
public void setBindValues(AttributeValue[] bindValues)
```
    Sets the bind values.
    
    Parameters:
    
    bindValues - the bind values
    
    (Published)
  - addColumnDescriptor
```
public void addColumnDescriptor(ColumnDescriptor colDesc)
```
    Adds a Column descriptor.
    
    Parameters:
    
    colDesc - the Column descriptor
    
    (Published)
  - setColumnDescriptors
```
public void setColumnDescriptors(ColumnDescriptor[] colDescs)
```
    Sets the Column descriptors.
    
    Parameters:
    
    colDescs - the ColumnDescriptors
    
    (Published)
  - addBypassSecurityAlias
```
public void addBypassSecurityAlias(String alias)
```
    Adds an alias that indicates the matching search target should not have the security clause applied.
    
    Parameters:
    
    alias - the alias that identifies the search target
    
    (Published)
  - setBypassSecurityAliases
```
public void setBypassSecurityAliases(String[] bypassSecAliases)
```
    Sets the aliases that indicates which PO classes should not have the security clause applied.
    
    Parameters:
    
    bypassSecAliases - the bypass security aliases
    
    (Published)
  - setJoinCondition
```
public void setJoinCondition(String joinCondition)
```
    Sets the join condition.
    
    Parameters:
    
    joinCondition - the join condition
    
    (Published)
  - setWhereCondition
```
public void setWhereCondition(String searchCondition)
```
    Sets the WHERE clause condition.
    
    Parameters:
    
    searchCondition - the search condition
    
    (Published)
  - setSortCondition
```
public void setSortCondition(String sortCondition)
```
    Sets the Sort condition.
    
    Parameters:
    
    sortCondition - the sort condition
    
    (Published)
  - setUseExistsClause
```
public void setUseExistsClause(Boolean useExists)
```
    Returns the explicit "Use exists clause" setting.
    
    (Published)
  - getPreparedSelector
```
public PreparedSelector getPreparedSelector()
                                     throws IfsException
```
    Gets the generated PreparedSelector.
    The returned instance has the required settings from the inputs specified during define(). Additional settings may be applied subsequently (e.g. adding a SQL hint).
    
    Returns:
    
    the PreparedSelector
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - getSession
```
public LibrarySession getSession()
```
    Gets the session context used by this instance.
    
    Returns:
    
    the session context
    
    (Published)
  - getJoinCondition
```
public String getJoinCondition()
```
    Gets the raw join condition.
    
    Returns:
    
    the join condition
    
    (Published)
  - getSearchCondition
```
public String getSearchCondition()
```
    Gets the raw search condition.
    
    Returns:
    
    the search condition
    
    (Published)
  - getSortCondition
```
public String getSortCondition()
```
    Gets the raw sort condition.
    
    Returns:
    
    the sort condition
    
    (Published)
  - getJoinClause
```
public String getJoinClause()
                     throws IfsException
```
    Returns the join clause used to specify the joins in a PreparedSelector.
    
    Returns:
    
    the generated join clause
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - getWhereClause
```
public String getWhereClause()
                      throws IfsException
```
    Returns the "where Clause" used as the search condition in a PreparedSelector.
    
    Returns:
    
    the generated where clause
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - getSortClause
```
public String getSortClause()
                     throws IfsException
```
    Returns the Sort Clause.
    
    Returns:
    
    the generated sort clause
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - getOriginalPrimarySearchTarget
```
public AttributeValue getOriginalPrimarySearchTarget()
```
    Returns the original primary search target, specified when defined.
    
    Returns:
    
    the original primary search target.
    
    (Published)
  - getOriginalAuxiliarySearchTargets
```
public AttributeValue[] getOriginalAuxiliarySearchTargets()
```
    Returns the original auxiliary search targets, specified when defined.
    
    Returns:
    
    the original auxiliary search targets.
    
    (Published)
  - getPrimarySearchTarget
```
public AttributeValue getPrimarySearchTarget()
                                      throws IfsException
```
    Returns the primary search target.
    
    Returns:
    
    the primary search target.
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - getAuxiliarySearchTargets
```
public AttributeValue[] getAuxiliarySearchTargets()
                                           throws IfsException
```
    Returns the auxiliary search targets.
    
    Returns:
    
    the auxiliary search targets.
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - getColumnDescriptors
```
public ColumnDescriptor[] getColumnDescriptors()
                                        throws IfsException
```
    Returns the Column descriptors.
    
    Returns:
    
    the ColumnDescriptors.
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - getBypassSecurityAliases
```
public String[] getBypassSecurityAliases()
                                  throws IfsException
```
    Returns the bypass security aliases.
    
    Returns:
    
    the bypass security aliases
    
    Throws:
    
    IfsException - if operation fails
    
    (Published)
  - getBindValues
```
public AttributeValue[] getBindValues()
                               throws IfsException
```
    Returns the bind values.
    
    Returns:
    
    the bind values.
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - getUseExistsClause
```
public Boolean getUseExistsClause()
                           throws IfsException
```
    Returns the explicit "Use exists clause" setting.
    
    Returns:
    
    the "Use exists clause" setting.
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Published)
  - validate
```
public void validate()
              throws IfsException
```
    Validate the search specifications.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)
  - validateJoinCondition
```
protected void validateJoinCondition(String joinCondition)
                              throws IfsException
```
    Validate the join condition.
    
    Parameters:
    
    joinCondition - the join condition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - validateSearchCondition
```
protected void validateSearchCondition(String search)
                                throws IfsException
```
    Validate the search condition.
    
    Parameters:
    
    search - the search condition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - validateSortCondition
```
protected void validateSortCondition(String sort)
                              throws IfsException
```
    Validate the sort condition.
    
    Parameters:
    
    sort - the sort condition
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - validateBindValue
```
protected AttributeValue validateBindValue(AttributeValue bindValue)
                                    throws IfsException
```
    Validate a bind value.
    
    Parameters:
    
    bindValue - the bind value.
    
    Returns:
    
    the validated and potentially modified bind value.
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Unpublished)
  - validateSearchTarget
```
protected AttributeValue validateSearchTarget(AttributeValue target)
                                       throws IfsException
```
    Validate a search target, and registers it if it is valid.
    
    Parameters:
    
    target - the search target.
    
    Returns:
    
    the validated, registered, and potentially modified search target.
    
    Throws:
    
    IfsException - if the operation fails.
    
    (Unpublished)
  - declareInnerSearchTarget
```
public void declareInnerSearchTarget(String input)
                              throws IfsException
```
    Deprecated. 9.3.3.0 use SEARCH_RESULT macro
    
    Declare an inner search target.
    This method should no longer be used. The input expression is: class alias where: class is a class name, nickname, or category display name, and alias is a valid table alias.
    
    Parameters:
    
    input - the input expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - registerSearchTarget
```
protected AttributeValue registerSearchTarget(String input)
                                       throws IfsException
```
    Parses and registers a new search target.
    The input expression is: class alias where: class is a class name, nickname, or category display name, and alias is a valid table alias.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the registered search target
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - registerSearchTarget
```
protected AttributeValue registerSearchTarget(AttributeValue searchTarget)
                                       throws IfsException
```
    Registers a new search target after validation.
    
    Parameters:
    
    searchTarget - the search target to register
    
    Returns:
    
    the registered search target (may be different object than the one specified)
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - findClassObjectByAuxName
```
protected ClassObject findClassObjectByAuxName(LibrarySession session,
                                               String className)
                                        throws IfsException
```
    Find a ClassObject using an auxilliary name.
    Subclasses can override this to provide alternate name checks, such as ECM code attempting a DisplayName lookup.
    
    Parameters:
    
    session - the session context
    
    className - the name given for the class
    
    Returns:
    
    the matching ClassObject, or null if no match
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - findAttributeByAuxName
```
protected Attribute findAttributeByAuxName(LibrarySession session,
                                           ClassObject co,
                                           String attrName)
                                    throws IfsException
```
    Lookup an Attribute using an auxilliary name.
    Used as a last resort when an attribute specification does not map to an attribute for the associated alias.
    
    Parameters:
    
    session - the session context.
    
    co - the ClassObject to look in.
    
    attrName - the name given for the attribute.
    
    Returns:
    
    the Attribute, or null if no match
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - lookupClassNameByNickname
```
protected String lookupClassNameByNickname(String nickname)
                                    throws IfsException
```
    Looks up a ClassObject name by the specified class "nickname".
    This can be overriden by subclasses, to provide nickname look for application-specific classes (e.g. for ECM). The caller ensures that the nickname is forced to uppercase.
    
    Parameters:
    
    nickname - the class nickname (must be all uppercase)
    
    Returns:
    
    the actual ClassObject name, or null if no match
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - lookupSearchTarget
```
protected AttributeValue lookupSearchTarget(String alias)
                                     throws IfsException
```
    Lookup a search target by registered alias.
    
    Parameters:
    
    alias - the registered alias.
    
    Returns:
    
    the search target.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - lookupSearchTarget
```
protected AttributeValue lookupSearchTarget(String alias,
                                            boolean enforce)
                                     throws IfsException
```
    Lookup a search target by registered alias.
    
    Parameters:
    
    alias - the registered alias.
    
    enforce - if true, throw an exception if not found; if false, return null if not found
    
    Returns:
    
    the search target.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getClassFromTarget
```
protected String getClassFromTarget(AttributeValue target)
                             throws IfsException
```
    Deprecated. 9.3.3.0 use getClassNameFromTarget
    
    Returns the class name from the specified search target.
    
    Parameters:
    
    target - the search target specification.
    
    Returns:
    
    the class name.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getClassNameFromTarget
```
protected String getClassNameFromTarget(AttributeValue target)
                                 throws IfsException
```
    Returns the class name from the specified search target.
    
    Parameters:
    
    target - the search target specification.
    
    Returns:
    
    the class name.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getAliasFromTarget
```
protected String getAliasFromTarget(AttributeValue target)
                             throws IfsException
```
    Returns the alias name from the specified search target.
    
    Parameters:
    
    target - the search target specification.
    
    Returns:
    
    the alias name.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getClassNameFromAlias
```
protected String getClassNameFromAlias(String alias)
                                throws IfsException
```
    Deprecated. 9.3.3.0 use getClassObjectFromAlias.
    
    Returns the Class name associated with the specified registered alias.
    Throws if the alias is not known.
    
    Parameters:
    
    alias - the search target alias
    
    Returns:
    
    the associated Class name.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getClassObjectFromAlias
```
protected ClassObject getClassObjectFromAlias(String alias)
                                       throws IfsException
```
    Returns the ClassObject associated with the specified registered alias.
    
    Parameters:
    
    alias - the search target alias
    
    Returns:
    
    the associated ClassObject.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getClassObjectFromTarget
```
protected ClassObject getClassObjectFromTarget(AttributeValue target)
                                        throws IfsException
```
    Returns the class object from the specified search target.
    
    Parameters:
    
    target - the search target specification.
    
    Returns:
    
    the ClassObject.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - lookupSearchTarget
```
protected AttributeValue lookupSearchTarget(AttributeValue target)
                                     throws IfsException
```
    Returns the search target from the table map matching the provided target's associated alias.
    
    Parameters:
    
    target - the provided search target.
    
    Returns:
    
    the corresponding search target in the table map.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - lookupSearchTargets
```
protected AttributeValue[] lookupSearchTargets(AttributeValue[] targets)
                                        throws IfsException
```
    Returns the search targets from the table map matching the provided targets associated aliases.
    
    Parameters:
    
    targets - the provided search targets.
    
    Returns:
    
    the corresponding search targets in the table map.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - verifyDocumentTarget
```
protected void verifyDocumentTarget(String alias)
                             throws IfsException
```
    Verify that the class name in the search target identified by the alias specified is DOCUMENT.
    If the class name is DOCUMENT, this method also overrides the view name in the search target, so that odmz_context_document is used in the search instead of odmv_document.
    
    Parameters:
    
    alias - the search target alias.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - overrideTargetViewName
```
protected void overrideTargetViewName(String alias,
                                      String viewName)
                               throws IfsException
```
    Overrides the view name to be used with the search target identified by the alias specified.
    
    Parameters:
    
    alias - the search target alias.
    
    viewName - the view name.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getSearchTargetSqlFromAlias
```
protected String getSearchTargetSqlFromAlias(String alias)
                                      throws IfsException
```
    Generates the SQL for a search target, identified by registered alias.
    The SQL is: "viewname alias".
    
    Parameters:
    
    alias - the registered alias.
    
    Returns:
    
    the SQL expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - throwInvalidFunction
```
protected void throwInvalidFunction(String funcName,
                                    String input)
                             throws IfsException
```
    Throw an exception indicating an invalid search function.
    
    Parameters:
    
    funcName - the function name.
    
    input - the input string.
    
    Throws:
    
    IfsException - IFS-35235
    
    (Unpublished)
  - isNumber
```
protected boolean isNumber(String value)
```
    Check if the input string represents a number.
    
    Parameters:
    
    value - the input string.
    
    Returns:
    
    true if string is a number; false otherwise.
    
    (Unpublished)
  - parseNumber
```
protected Long parseNumber(String value)
```
    Return numeric equivalent of the specified string, or return null if not a number.
    
    Parameters:
    
    value - the input string.
    
    Returns:
    
    the number, or null if string is not numeric
    
    (Unpublished)
  - computeDateValueRange
```
protected long[] computeDateValueRange(Long dateValue,
                                       String granularity)
                                throws IfsException
```
    Compute a low/high value range for the specified numeric date value, using the specified granularity.
    For example, if the date value specified was the numeric represenation of '14-aug-2009 17:50:20' and a comparison level of MONTH is specified, then the range returned is '01-aug-2009 00:00:00.0' and '31-aug-2009 23:59:59.999'.
    
    Parameters:
    
    dateValue - a non-null numeric date value, obtained via getTime on a java.util.Date
    
    granularity - the granularity, one of "YEAR", "MONTH", "DAY", "HOUR", "MINUTE", or "SECOND"
    
    Returns:
    
    the low and high range values
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - createSearchTarget
```
public static AttributeValue createSearchTarget(String targetToken)
                                         throws IfsException
```
    Create a search target specification.
    Format of the string is [ ]. This methid simply delegates to PreparedSelector.createSearchTarget.
    
    Parameters:
    
    targetToken - the string token representing the search target
    
    Returns:
    
    the search target specification
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - parseInput
```
protected List parseInput(String input)
                   throws IfsException
```
    Create a token list from an input string.
    The list will be compromised of both literal Strings and SelectorFunctions.
    
    Parameters:
    
    input - the input string.
    
    Returns:
    
    the list of tokens.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - findFunctionStart
```
protected int findFunctionStart(String input,
                                int lcurlyPos)
                         throws IfsException
```
    Find the start of the function, given a string and the position of the left curly.
    
    Parameters:
    
    input - the input string
    
    lcurlyPos - the position of the left curly
    
    Returns:
    
    the position where the function name begins.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - findFunctionEnd
```
protected int findFunctionEnd(String input,
                              int lcurlyPos)
                       throws IfsException
```
    Find the closing right curly that marks the end of the function, given a string and the position of the left curly.
    
    Parameters:
    
    input - the input string
    
    lcurlyPos - the position of the left curly
    
    Returns:
    
    the position where the function ends.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - concatTokenList
```
protected String concatTokenList(List list)
                          throws IfsException
```
    Concatenate a list of tokens, comprised of literal strings and functions.
    
    Parameters:
    
    list - the token list.
    
    Returns:
    
    the resultant string.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - LITERAL
```
public String LITERAL(String input)
               throws IfsException
```
    A no-op function, returning the literal resolution of the input string.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - EXACT_TYPE
```
public String EXACT_TYPE(String input)
                  throws IfsException
```
    Adds a qualification that requires an exact type match.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - CONTENT_SIZE
```
public String CONTENT_SIZE(String input)
                    throws IfsException
```
    Adds the SQL referencing the content size as a column in a search or sort condition.
    Derived from ContentObject.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - CONTENT_SCORE
```
public String CONTENT_SCORE(String input)
                     throws IfsException
```
    Adds the SQL referencing the content score as a column in a search or sort condition.
    This function is only supported if the underlying database is Oracle.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - CONTAINS_SCORE
```
public String CONTAINS_SCORE(String input)
                      throws IfsException
```
    Adds the SQL referencing the "Contains" score as a column in a search or sort condition.
    The input must be specified as: alias, ?, n
    NOTE: the alias must be associated with a DOCUMENT_CONTEXT search target. NOTE: For Postgres, the score number is ignored.
    The SQL generated for Oracle is: coalesce(CTXSYS.SCORE(n), length(?) * 0)
    The SQL generated for Postgres is: ts_rank(alias.indexvector, to_tsquery(?))
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - CONTAINS
```
public String CONTAINS(String input)
                throws IfsException
```
    Adds a clause that restricts results according to a full text search qualification.
    The input must be specified as one of: alias, ? or alias, ?, n
    NOTE: the alias must be associated with a DOCUMENT_CONTEXT search target. NOTE: For Postgres, the score number is ignored.
    The SQL generated for Oracle is one of: (CTXSYS.CONTAINS(alias.contentindex, ?) > 0) or (CTXSYS.CONTAINS(alias.contentindex, ?, n) > 0)
    The SQL generated for Postgres is: alias.indexvector @@ to_tsquery(?)
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - LATEST_VERSION
```
public String LATEST_VERSION(String input)
                      throws IfsException
```
    Adds a qualification that restricts results for only the latest version or unversioned items.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - SEARCH_TARGET
```
public String SEARCH_TARGET(String input)
                     throws IfsException
```
    Registers a new search target, and generates SQL for it to appear in a "from clause".
    The input expression is: class alias where: class is a class name, nickname, or application-specific display name, and alias is a valid table alias.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - CLASS_TABLENAME
```
public String CLASS_TABLENAME(String input)
                       throws IfsException
```
    Translates a ClassObject name into a table name.
    The input expression is: classobject_name where: classobject_name is the class name.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - CLASS_VIEWNAME
```
public String CLASS_VIEWNAME(String input)
                      throws IfsException
```
    Translates a ClassObject name into a view name.
    The input expression is: classobject_name where: classobject_name is the class name.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - AUDIT_TABLENAME
```
public String AUDIT_TABLENAME(String input)
                       throws IfsException
```
    Translates an AuditSpecification name into the table name used for that Audit history.
    The input expression is: auditspecification_name where: auditspecification_name is the AuditSpecification name.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - AUDIT_VIEWNAME
```
public String AUDIT_VIEWNAME(String input)
                      throws IfsException
```
    Translates an AuditSpecification name into the view name used for that Audit history.
    The input expression is: auditspecification_name where: auditspecification_name is the AuditSpecification name.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - ATTR
```
public String ATTR(String input)
            throws IfsException
```
    Translates an attribute specification into a column specification.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - CATEGORY_JOIN
```
public String CATEGORY_JOIN(String input)
                     throws IfsException
```
    Generates a join clause between two targets, one being a category target.
    The input expression is of the form: assocAlias, catAlias.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - RELATION_JOIN
```
public String RELATION_JOIN(String input)
                     throws IfsException
```
    Generates a join clause between a left PublicObject, a right PublicObject, and a Relation that connects the two.
    The input expression is of the form: leftAlias, relationAlias, rightAlias.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - IN_FOLDER
```
public String IN_FOLDER(String input)
                 throws IfsException
```
    Generates the clause that restricts a specified alias to a particular folder.
    The input expression is of the form: alias, ?. A bind value indicator must be used for the folder.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - UNDER_FOLDER
```
public String UNDER_FOLDER(String input)
                    throws IfsException
```
    Generates the clause that restricts a specified alias to a particular folder or one of its subfolders.
    The input expression must be one of two forms: alias, ? or alias, nnnnn, where nnnnn is the ID of the top folder. The first variant may only be used if the FolderIndex's MaxLevel parameter is set to 0, and the corresponding bind value will be the top folder. Otherwise, the second variant must be used.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - EXISTS
```
public String EXISTS(String input)
              throws IfsException
```
    Adds a qualification for a simple "exists" specification.
    The input expression must be: class alias, ... class alias, condition. where:
    - "class alias" follows the same syntax as in search target specifications,
    - "condition" can be any valid search condition, which is included in a subselect. It is recommended that the search condition be enclosed in a LITERAL function, as: LITERAL{condition}
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - UPPER
```
public String UPPER(String input)
             throws IfsException
```
    Adds an upper function.
    For Oracle this will be nls_upper.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - LOWER
```
public String LOWER(String input)
             throws IfsException
```
    Applies a lowercasing SQL function.
    For Oracle this will be "nls_lower"; for Postgres it is "LOWER".
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - SECURITY_CLAUSE
```
public String SECURITY_CLAUSE(String input)
                       throws IfsException
```
    Adds a security qualification for an alias.
    Input must be "alias, ?", where the bind value indication is for the current user ID. If the specified registered alias is associated with a PublicObject class, a discover-security clause is returned. Otherwise, a clause of "29 != ?" is returned (which will always be true).
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - DATE_COMPARE
```
public String DATE_COMPARE(String input)
                    throws IfsException
```
    Generates a date comparison clause from a specified attribute, a logical operator, a date value, and a granularity value.
    The operator must be one of: =, !=, >, >=, <, or <=. The granularity must be one of: YEAR, MONTH, DAY, HOUR, MINUTE, or SECOND. Case is not significant for these values.
    The input expression is of the form: , , , . For example, for comparing an attribute named "archivedate" equal to the current time, with day granularity: DATE_COMPARE{ATTR{cat.archivedate}, =, DATE_VALUE_NOW{}, Day}.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - DATE_VALUE_NOW
```
public String DATE_VALUE_NOW(String input)
                      throws IfsException
```
    Generates a numeric value representing the current time.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - PROPERTY
```
public String PROPERTY(String input)
                throws IfsException
```
    Generates a property qualification clause from a specified alias, property name, and property data type.
    The property name must be either a literal string or a bind variable. The property data type must be one of the supported scalar types: STRING, BOOLEAN, INTEGER, LONG, DOUBLE, or DATE. Case is not significant for these values.
    The input expression is of the form: , , . For example: PROPERTY{d, IFS.DOCUMENT.ThumbnailStatus, String} = ?.
    The SQL emitted for the above clause is: (select stringvalue from odm_property where name = 'IFS.DOCUMENT.ThumbnailStatus' and bundle = d.propertybundle) = ?
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - ARRAY_ATTR_CONTAINS
```
public String ARRAY_ATTR_CONTAINS(String input)
                           throws IfsException
```
    Generates a array attribute qualification clause from a specified attribute and value.
    The input expression is of the form: ., . The value can be literal or a bind variable. For example: ARRAY_ATTR_CONTAINS{d.AssociatedProjects, ?}.
    The SQL emitted for the above clause is: exists (select 1 from where objectid = d.id and attributeid = and value = ?) Where tblName is the string literal for the array attribute table name (which varies based on data type), and attrId is the literal ID of the Attribute specified.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - ARRAY_ATTR_CONTAINS_ANY
```
public String ARRAY_ATTR_CONTAINS_ANY(String input)
                               throws IfsException
```
    Generates a array attribute qualification clause from a specified attribute and a set of values, resulting in a match if the array value contains any of the specified values.
    The input expression is of the form: ., [, valueN]. The values can be literal or be bind variables, including a combination of each type. For example: ARRAY_ATTR_CONTAINS_ANY{d.AssociatedProjects, ?, ?, ?}.
    The SQL emitted for the above clause is: exists (select 1 from where objectid = d.id and attributeid = and value = ? or value = ? or value = ?) Where tblName is the string literal for the array attribute table name (which varies based on data type), and attrId is the literal ID of the Attribute specified.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - CONTAINS_WORD
```
public String CONTAINS_WORD(String input)
                     throws IfsException
```
    Generates a word-boundary LIKE qualification.
    The input expression is of the form: ., . The value can be literal or a bind variable. For example: CONTAINS_WORD{ATTR{d.name}, ?}.
    The SQL emitted for the above clause is: ' '||translate(d.name, chr(9)||chr(10)||chr(13), ' ')||' ' like '% '||?||' %'
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - DOES_NOT_CONTAIN_WORD
```
public String DOES_NOT_CONTAIN_WORD(String input)
                             throws IfsException
```
    Generates a word-boundary NOT LIKE qualification.
    The input expression is of the form: ., . The value can be literal or a bind variable. For example: DOES_NOT_CONTAIN_WORD{ATTR{d.name}, ?}.
    The SQL emitted for the above clause is: ' '||translate(d.name, chr(9)||chr(10)||chr(13), ' ')||' ' not like '% '||?||' %'
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - ARRAY_ATTR_CONTAINS_ALL
```
public String ARRAY_ATTR_CONTAINS_ALL(String input)
                               throws IfsException
```
    Generates a array attribute qualification clause from a specified attribute and a set of values, resulting in a match if the array value contains all of the specified values.
    The input expression is of the form: ., [, valueN]. The values can be literal or be bind variables, including a combination of each type. For example: ARRAY_ATTR_CONTAINS_ALL{d.AssociatedProjects, ?, ?, ?}.
    The SQL emitted for the above clause is: (exists (select 1 from where objectid = d.id and attributeid = and value = ?) and exists (select 1 from where objectid = d.id and attributeid = and value = ?) and exists (select 1 from where objectid = d.id and attributeid = and value = ?) ) Where tblName is the string literal for the array attribute table name (which varies based on data type), and attrId is the literal ID of the Attribute specified.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - MAP_ATTR_KEYED_VALUE
```
public String MAP_ATTR_KEYED_VALUE(String input)
                            throws IfsException
```
    Generates a map attribute qualification clause containing a non-null key match from a specified attribute and key value.
    The input expression is of the form: ., . The keyvalue can be literal or a bind variable (bind variable is recommended). For example: MAP_ATTR_KEYED_VALUE{d.Nicknames, ?}.
    The SQL emitted for the above clause is: (select value from where objectid = d.id and attributeid = and mapkey = ?) Where maptblName is the string literal for the map attribute table name (which is determined from the attribute specified), and attrId is the literal ID of the Attribute specified.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - MAP_ATTR_EXISTS
```
public String MAP_ATTR_EXISTS(String input)
                       throws IfsException
```
    Generates a map attribute qualification exists clause containing an arbitrary inner search clause with the map table.
    The input expression is of the form: ., . The innersearchclause can be any search clause that includes map table qualifications, and may include other functions. Examples: MAP_ATTR_EXISTS{d.Nicknames, mapkey like ? and value like ?} MAP_ATTR_EXISTS{d.Nicknames, mapkey is null and value like ?} MAP_ATTR_EXISTS{d.Nicknames, mapkey = d.currentteam and value is null}
    The SQL emitted for first clause above is: exists (select 1 from where objectid = d.id and attributeid = mapkey like ? and value like ?) Where maptblName is the string literal for the map attribute table name (which is determined from the attribute specified), and attrId is the literal ID of the Attribute specified.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - MAP_ATTR_EXISTS_WITH_ALIAS
```
public String MAP_ATTR_EXISTS_WITH_ALIAS(String input)
                                  throws IfsException
```
    Generates a map attribute qualification exists clause with a defined alias for the map table, and containing an arbitrary inner search clause with the map table.
    The input expression is of the form: ., , . The innersearchclause can be any search clause that includes map table qualifications, and may include other functions. The Map alias must not conflict with any of the primary or auxiliary search aliases. Example: MAP_ATTR_EXISTS_WITH_ALIAS{d.Nicknames, map1, mapkey is null and MAP_ATTR_EXISTS{d.DefaultNames, mapkey = map1.value}}
    The SQL emitted for the clause above is: exists (select 1 from map1 where objectid = d.id and attributeid = mapkey is null and exists (select 1 from where objectid = d.id and attributeid = and mapkey = map1.value)) Where maptblName1 and maptblName2 are the table names for map attributes Nicknames and DefaultNames, respectively, and attrId1 and attrId2 are the literal IDs of the Attributes specified.
    
    Parameters:
    
    input - the input expression.
    
    Returns:
    
    the resolved expression.
    
    Throws:
    
    IfsException - if operation fails.
    
    (Unpublished)
  - getFunctionMethod
```
protected Method getFunctionMethod(String key)
                            throws IfsException
```
    Gets the method to use for resolving the specified function.
    
    Parameters:
    
    key - the method name
    
    Returns:
    
    the method
    
    Throws:
    
    IfsException - if the operation fails
    
    (Published)

Class PreparedSelectorGenerator

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CONTEXT_DOCUMENT_VIEW_NAME

Constructor Detail

PreparedSelectorGenerator

Method Detail

registerFunctionMethods

define

define

define

define

define

define

setSession

setPrimarySearchTarget

setPrimarySearchTarget

setPrimarySearchTarget

addAuxiliarySearchTarget

addAuxiliarySearchTarget

addAuxiliarySearchTarget

setAuxiliarySearchTargets

addBindValue

setBindValues

addColumnDescriptor

setColumnDescriptors

addBypassSecurityAlias

setBypassSecurityAliases

setJoinCondition

setWhereCondition

setSortCondition

setUseExistsClause

getPreparedSelector

getSession

getJoinCondition

getSearchCondition

getSortCondition

getJoinClause

getWhereClause

getSortClause

getOriginalPrimarySearchTarget

getOriginalAuxiliarySearchTargets

getPrimarySearchTarget

getAuxiliarySearchTargets

getColumnDescriptors

getBypassSecurityAliases

getBindValues

getUseExistsClause

validate

validateJoinCondition

validateSearchCondition

validateSortCondition

validateBindValue

validateSearchTarget

declareInnerSearchTarget

registerSearchTarget

registerSearchTarget

findClassObjectByAuxName

findAttributeByAuxName

lookupClassNameByNickname

lookupSearchTarget

lookupSearchTarget

getClassFromTarget

getClassNameFromTarget

getAliasFromTarget

getClassNameFromAlias

getClassObjectFromAlias

getClassObjectFromTarget

lookupSearchTarget

lookupSearchTargets

verifyDocumentTarget

overrideTargetViewName

getSearchTargetSqlFromAlias

throwInvalidFunction

isNumber

parseNumber