oracle.ifs.beans

Class PreparedSelector

java.lang.Object

oracle.ifs.beans.PreparedSelector

Direct Known Subclasses:

TiePreparedSelector

public class PreparedSelector
extends Object

A PreparedSelector class is used to perform a simple search using a cached PreparedStatement, and optionally using bind variables.

Author:

Dave Long

(Unpublished)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ALIAS The default search alias.

Constructor Summary

Constructors

Constructor and Description
PreparedSelector(LibrarySession session) Constructs a PreparedSelector.

Method Summary

Modifier and Type	Method and Description
protected void	applySortSpecificationDefaults() Applies the primary search target settings as the default class/alias for the current sort specification.
static AttributeValue	createSearchTarget(String classAndAlias) Create a search target specification, from a single space-delimited String that has the ClassObject name and alias.
static AttributeValue	createSearchTarget(String className, String alias) Create a search target specification, from a ClassObject name and alias.
static AttributeValue	createSearchTarget(String className, String alias, String viewName) Create a search target specification, from an optional ClassObject name, an alias, and an explicit table or view name.
String	deriveViewFromTarget(AttributeValue target) Derives the view name from the specified search target.
static String	getAliasFromTarget(AttributeValue target) Returns the alias name from the specified search target.
static String	getAliasFromTarget(LibrarySessionInterface session, AttributeValue target) Deprecated. 9.3.3.0 use variant without a session context
AttributeValue[]	getAuxiliarySearchTargets() Returns the auxiliary search targets.
AttributeValue[]	getBindValues() Gets the bind values to use in the select statement.
String[]	getBypassSecurityAliases() Returns the bypass security aliases that were set using setBypassSecurityAliases().
protected String	getClassFromTarget(AttributeValue target) Deprecated. 9.3.3.0 use getClassNameFromTarget
static String	getClassNameFromTarget(AttributeValue target) Returns the class name from the specified search target.
ColumnDescriptor[]	getColumnDescriptors() Gets the column descriptors to use in the select statement.
String	getCompleteSqlStatement() Gets the complete SQL statement that will be used.
String	getCompleteSqlStatement(String delim) Gets the complete SQL statement that will be used.
static String	getExistsSecurityClause(String alias, String attrName) Return a condition that can be used to restrict results based on the user's ability to discover the object referred to by an attribute.
String	getHint() Gets the SQL hint to use for the main select.
int	getItemCount() Returns the search result count.
LibraryObject[]	getItems() Returns the entire search results as an array.
String	getJoinCondition() Returns the join condition that was set using setJoinCondition().
int	getMaxItemCount() Returns the maximum number of items that will be returned by getItems.
String	getPrimarySearchAlias() Returns the alias used for the primary search class.
String	getPrimarySearchClass() Returns the search class that was previously set.
AttributeValue	getPrimarySearchTarget() Returns the primary search target.
String	getSearchLanguage() Returns the search language in effect.
AttributeValueTable[]	getSearchResults() Returns the search results as an array of AttributeValueTable, with each AttributeValueTable representing a row from the underlying ResultSet.
String	getSearchSelection() Returns the search selection that was set using setSearchSelection()
LibrarySession	getSession() Returns the session being used by this Selector.
SortSpecification	getSortSpecification() Returns the Sort Specification.
String[]	getSqlStatement() Gets the SQL statement that will be used.
int	getStartingRowNumber() Returns the starting row number.
String	getStatementKey() Returns the statement key.
static String	getViewFromTarget(AttributeValue target) Returns the overridden view name from the specified search target.
static String	getViewFromTarget(LibrarySessionInterface session, AttributeValue target) Deprecated. 9.3.3.0 use variant without a session context
boolean	isAlwaysCacheSelectedData() Gets whether to force caching of selected data.
boolean	isDistinct() Returns true if distinct searching is enabled with respect to classes.
boolean	isRecursiveSearch() Returns true if recursive searching is enabled with respect to classes.
void	setAlwaysCacheSelectedData(boolean value) Sets whether to force caching of selected data.
void	setAuxiliarySearchTargets(AttributeValue[] targets) Sets the auxiliary search targets.
void	setBindValues(AttributeValue[] bindValues) Sets the bind values to use in the select statement.
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 to use in the select statement.
void	setDistinct(boolean distinct) Sets the indication as to whether a "select distinct" will be used.
void	setHint(String hint) Sets the SQL hint to use for the main select.
void	setJoinCondition(String joinCondition) Sets the join condition.
void	setMaxItemCount(int maxItemCount) Sets the maximum number of items that will be returned by getItems.
void	setPrimarySearchClass(String className) Sets the primary search target, specifying the class name only.
void	setPrimarySearchTarget(AttributeValue target) Sets the primary search target.
void	setRecursiveSearch(boolean recursive) Enables/disables recursive searching with respect to classes.
void	setSearchClassname(String searchClass) Deprecated. 11.1.1.1 use setPrimarySearchClass
void	setSearchLanguage(String language) Sets the search language.
void	setSearchSelection(String searchSelection) Sets the search selection.
void	setSortSpecification(SortSpecification sort) Sets the Sort Specification.
void	setSortSpecification(String sortCondition) Sets the Sort Specification for the specified string.
void	setStartingRowNumber(int rowNumber) Sets the starting row number.
void	setStatementKey(String key) Sets the statement key.
protected LibrarySession	verifyConnected() Return the current LibrarySession if the session is connected; otherwise raise a "not connected" exception.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ALIAS

public static final String DEFAULT_ALIAS

The default search alias.

See Also:

Constant Field Values

Constructor Detail

PreparedSelector

public PreparedSelector(LibrarySession session)
                 throws IfsException

Constructs a PreparedSelector.

Parameters:

session - the current session.

Throws:

IfsException - if the operation fails.

Method Detail

getSession

public LibrarySession getSession()
                          throws IfsException

Returns the session being used by this Selector.

Returns:

the current session

Throws:

IfsException - if the operation fails.

getStatementKey

public String getStatementKey()
                       throws IfsException

Returns the statement key.

Returns:

the statement key

Throws:

IfsException - if the operation fails.

getSortSpecification

public SortSpecification getSortSpecification()
                                       throws IfsException

Returns the Sort Specification.

Returns:

the search item sort specificaion.

Throws:

IfsException - if the operation fails.

getPrimarySearchTarget

public AttributeValue getPrimarySearchTarget()
                                      throws IfsException

Returns the primary search target.

The AttributeValue returned encapulates the class name (as the AttributeValue's name) and the alias (as the AttributeValue's value).

Returns:

the primary search target.

Throws:

IfsException - if operation fails.

getAuxiliarySearchTargets

public AttributeValue[] getAuxiliarySearchTargets()
                                           throws IfsException

Returns the auxiliary search targets.

The AttributeValues returned encapulate the class name (as the AttributeValue's name) and the alias (as the AttributeValue's value).

Returns:

the auxiliary search targets.

Throws:

IfsException - if operation fails.

getPrimarySearchClass

public String getPrimarySearchClass()
                             throws IfsException

Returns the search class that was previously set.

Returns:

the search class.

Throws:

IfsException - if operation fails.

getPrimarySearchAlias

public String getPrimarySearchAlias()
                             throws IfsException

Returns the alias used for the primary search class.

Returns:

the primary search alias.

Throws:

IfsException - if operation fails.

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.

getColumnDescriptors

public ColumnDescriptor[] getColumnDescriptors()
                                        throws IfsException

Gets the column descriptors to use in the select statement.

Returns:

the column descriptors

Throws:

IfsException - if the operation fails.

getBypassSecurityAliases

public String[] getBypassSecurityAliases()
                                  throws IfsException

Returns the bypass security aliases that were set using setBypassSecurityAliases().

Returns:

the bypass security aliases

Throws:

IfsException - if operation fails.

getJoinCondition

public String getJoinCondition()
                        throws IfsException

Returns the join condition that was set using setJoinCondition().

Returns:

the join condition

Throws:

IfsException - if operation fails.

getSearchSelection

public String getSearchSelection()
                          throws IfsException

Returns the search selection that was set using setSearchSelection()

Returns:

the search selection.

Throws:

IfsException - if operation fails.

isDistinct

public boolean isDistinct()
                   throws IfsException

Returns true if distinct searching is enabled with respect to classes.

Returns:

true if distinct enabled.

Throws:

IfsException - if the operation fails.

isAlwaysCacheSelectedData

public boolean isAlwaysCacheSelectedData()
                                  throws IfsException

Gets whether to force caching of selected data.

Returns:

true if selected data should be cached; false otherwise

Throws:

IfsException - if the operation fails

(Published)

isRecursiveSearch

public boolean isRecursiveSearch()
                          throws IfsException

Returns true if recursive searching is enabled with respect to classes.

Returns:

true if recursive enabled.

Throws:

IfsException - if the operation fails.

getSearchLanguage

public String getSearchLanguage()
                         throws IfsException

Returns the search language in effect.

A value of null indicates that the default language should be used.

Returns:

the search language in effect

Throws:

IfsException - if operation fails.

getMaxItemCount

public int getMaxItemCount()
                    throws IfsException

Returns the maximum number of items that will be returned by getItems.

A value of zero indicates that there is no limit on the desired number of items.

Returns:

maximum number of items that will be returned

Throws:

IfsException - if the operation fails.

getStartingRowNumber

public int getStartingRowNumber()
                         throws IfsException

Returns the starting row number.

The value is 1-based, meaning that if the value is set to 101, the first 100 rows will be skipped. A value of zero or less is treated the same same as a setting of 1, indicating that no rows are skipped.

Returns:

the starting row number

Throws:

IfsException - if the operation fails.

getHint

public String getHint()
               throws IfsException

Gets the SQL hint to use for the main select.

Returns:

the SQL hint

Throws:

IfsException - if the operation fails.

getBindValues

public AttributeValue[] getBindValues()
                               throws IfsException

Gets the bind values to use in the select statement.

Returns:

the bind values

Throws:

IfsException - if the operation fails.

getCompleteSqlStatement

public String getCompleteSqlStatement()
                               throws IfsException

Gets the complete SQL statement that will be used.

A single space is used as the delimitter between the SQL fragments.

Returns:

the complete SQL statement

Throws:

IfsException - if the operation fails.

getCompleteSqlStatement

public String getCompleteSqlStatement(String delim)
                               throws IfsException

Gets the complete SQL statement that will be used.

Returns a concatenation of the SQL fragments (select, from, where, sort) that will be emitted for the query. Each of the fragments is seperated by the specified delimitter, typically a newline or space.

Parameters:

delim - the delimitter to use between sections of the SQL

Returns:

the complete SQL statement

Throws:

IfsException - if the operation fails.

getSqlStatement

public String[] getSqlStatement()
                         throws IfsException

Gets the SQL statement that will be used.

The SQL is returned as an array of strings, that when concatenated with space delimiters is the SQL emited for this selector. The elements of the array contain the following elements:

• the selected columns
• the from clause
• the join condition
• the where clause
• the order by clause

Returns:

the SQL statement

Throws:

IfsException - if the operation fails.

setStatementKey

public void setStatementKey(String key)
                     throws IfsException

Sets the statement key.

Parameters:

key - the statement key.

Throws:

IfsException - if operation fails.

setDistinct

public void setDistinct(boolean distinct)
                 throws IfsException

Sets the indication as to whether a "select distinct" will be used.

Parameters:

distinct - true if distinct is used; false otherwise.

Throws:

IfsException - if operation fails.

setAlwaysCacheSelectedData

public void setAlwaysCacheSelectedData(boolean value)
                                throws IfsException

Sets whether to force caching of selected data.

Parameters:

value - true if selected data should be cached; false otherwise

Throws:

IfsException - if the operation fails

(Published)

setPrimarySearchTarget

public void setPrimarySearchTarget(AttributeValue target)
                            throws IfsException

Sets the primary search target.

Parameters:

target - the primary search target.

Throws:

IfsException - if operation fails.

setPrimarySearchClass

public void setPrimarySearchClass(String className)
                           throws IfsException

Sets the primary search target, specifying the class name only.

Parameters:

className - the search class.

Throws:

IfsException - if operation fails.

setSearchClassname

public void setSearchClassname(String searchClass)
                        throws IfsException

Deprecated. 11.1.1.1 use setPrimarySearchClass

Sets the primary search class.

Parameters:

searchClass - the primary search class.

Throws:

IfsException - if operation fails.

setAuxiliarySearchTargets

public void setAuxiliarySearchTargets(AttributeValue[] targets)
                               throws IfsException

Sets the auxiliary search targets.

Parameters:

targets - the auxiliary search targets.

Throws:

IfsException - if operation fails.

setSortSpecification

public void setSortSpecification(String sortCondition)
                          throws IfsException

Sets the Sort Specification for the specified string.

Parameters:

sortCondition - the sort condition

Throws:

IfsException - if the operation fails.

setSortSpecification

public void setSortSpecification(SortSpecification sort)
                          throws IfsException

Sets the Sort Specification.

Parameters:

sort - the sort specificaion.

Throws:

IfsException - if the operation fails.

applySortSpecificationDefaults

protected void applySortSpecificationDefaults()
                                       throws IfsException

Applies the primary search target settings as the default class/alias for the current sort specification.

Throws:

IfsException - if the operation fails.

(Unpublished)

setColumnDescriptors

public void setColumnDescriptors(ColumnDescriptor[] colDescs)
                          throws IfsException

Sets the column descriptors to use in the select statement.

Parameters:

colDescs - the column descriptors

Throws:

IfsException - if the operation fails.

setBypassSecurityAliases

public void setBypassSecurityAliases(String[] bypassSecAliases)
                              throws IfsException

Sets the aliases that indicates which PO classes should not have the security clause applied.

Parameters:

bypassSecAliases - the bypass security aliases

Throws:

IfsException - if operation fails.

setJoinCondition

public void setJoinCondition(String joinCondition)
                      throws IfsException

Sets the join condition.

Parameters:

joinCondition - the join condition

Throws:

IfsException - if operation fails.

setSearchSelection

public void setSearchSelection(String searchSelection)
                        throws IfsException

Sets the search selection.

Parameters:

searchSelection - the search selection.

Throws:

IfsException - if operation fails.

setRecursiveSearch

public void setRecursiveSearch(boolean recursive)
                        throws IfsException

Enables/disables recursive searching with respect to classes. The default is set true. This is equivalent to adding _R to the class name in extended SQL syntax.

Parameters:

recursive - true for enabled.

Throws:

IfsException - if the operation fails.

setSearchLanguage

public void setSearchLanguage(String language)
                       throws IfsException

Sets the search language.

A value of null indicates that the default language should be used.

Parameters:

language - the search language

Throws:

IfsException - if operation fails.

setMaxItemCount

public void setMaxItemCount(int maxItemCount)
                     throws IfsException

Sets the maximum number of items that will be returned by getItems.

A value of zero indicates that there is no limit on the desired number of items.

Parameters:

maxItemCount - maximum number of items that will be returned

Throws:

IfsException - if the operation fails.

setStartingRowNumber

public void setStartingRowNumber(int rowNumber)
                          throws IfsException

Sets the starting row number.

The value is 1-based, meaning that if the value is set to 101, the first 100 rows will be skipped. A value of zero or less is treated the same same as a setting of 1, indicating that no rows are skipped.

Parameters:

rowNumber - the starting row number

Throws:

IfsException - if the operation fails.

setHint

public void setHint(String hint)
             throws IfsException

Sets the SQL hint to use for the main select.

Parameters:

hint - the SQL hint

Throws:

IfsException - if the operation fails.

setBindValues

public void setBindValues(AttributeValue[] bindValues)
                   throws IfsException

Sets the bind values to use in the select statement.

Parameters:

bindValues - the bind values

Throws:

IfsException - if the operation fails.

getItems

public LibraryObject[] getItems()
                         throws IfsException

Returns the entire search results as an array.

Returns:

the search results.

Throws:

IfsException - if operation fails.

getSearchResults

public AttributeValueTable[] getSearchResults()
                                       throws IfsException

Returns the search results as an array of AttributeValueTable, with each AttributeValueTable representing a row from the underlying ResultSet.

Returns:

the search results.

Throws:

IfsException - if operation fails.

getItemCount

public int getItemCount()
                 throws IfsException

Returns the search result count.

Returns:

the search result count.

Throws:

IfsException - if operation fails.

verifyConnected

protected LibrarySession verifyConnected()
                                  throws IfsException

Return the current LibrarySession if the session is connected; otherwise raise a "not connected" exception.

Returns:

the current session

Throws:

IfsException - 21000: if not connected

createSearchTarget

public static AttributeValue createSearchTarget(String classAndAlias)
                                         throws IfsException

Create a search target specification, from a single space-delimited String that has the ClassObject name and alias.

Format of the string is [ ]. If the alias is omitted, and alias of "x" is used by default (this is for historical reasons).

Parameters:

classAndAlias - the string token representing the search target (class and alias)

Returns:

the search target specification

Throws:

IfsException - if the operation fails

createSearchTarget

public static AttributeValue createSearchTarget(String className,
                                                String alias)
                                         throws IfsException

Create a search target specification, from a ClassObject name and alias.

Parameters:

className - the class name

alias - the alias

Returns:

the search target specification

Throws:

IfsException - if the operation fails

createSearchTarget

public static AttributeValue createSearchTarget(String className,
                                                String alias,
                                                String viewName)
                                         throws IfsException

Create a search target specification, from an optional ClassObject name, an alias, and an explicit table or view name.

Parameters:

className - the class name (can be null)

alias - the alias

viewName - the literal view or table name

Returns:

the search target specification

Throws:

IfsException - if the operation fails

getClassNameFromTarget

public static 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 (can be null).

Throws:

IfsException - if operation fails.

getAliasFromTarget

public static String getAliasFromTarget(LibrarySessionInterface session,
                                        AttributeValue target)
                                 throws IfsException

Deprecated. 9.3.3.0 use variant without a session context

Returns the alias name from the specified search target.

Parameters:

session - the session context

target - the search target specification.

Returns:

the alias name.

Throws:

IfsException - if operation fails.

getAliasFromTarget

public static 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.

getViewFromTarget

public static String getViewFromTarget(LibrarySessionInterface session,
                                       AttributeValue target)
                                throws IfsException

Deprecated. 9.3.3.0 use variant without a session context

Returns the overridden view name from the specified search target.

Parameters:

session - the session context

target - the search target specification.

Returns:

the view name, or null if no override is specified.

Throws:

IfsException - if operation fails.

getViewFromTarget

public static String getViewFromTarget(AttributeValue target)
                                throws IfsException

Returns the overridden view name from the specified search target.

Parameters:

target - the search target specification.

Returns:

the view name, or null if no override is specified.

Throws:

IfsException - if operation fails.

deriveViewFromTarget

public String deriveViewFromTarget(AttributeValue target)
                            throws IfsException

Derives the view name from the specified search target.

Parameters:

target - the search target specification.

Returns:

the view name

Throws:

IfsException - if operation fails.

getExistsSecurityClause

public static String getExistsSecurityClause(String alias,
                                             String attrName)

Return a condition that can be used to restrict results based on the user's ability to discover the object referred to by an attribute.

Returns a SQL-style "exists" clause that will exclude all rows except for the ones where the value of the specified PublicObject attribute can be discovered by the current user.

The caller must ensure that the specified attribute is of type PublicObject.

This condition contains one bind value indicator (?) that corresponds to the requesting user ID. The current User's ID should be specified as a bind value on the PreparedSelector if this condition is included in the search selection criteria.

Parameters:

alias - the table alias; defaults to "x" if null

attrName - the attribute for which discoverability will be checked

Returns:

the condition which can be included in the Search Selection (where clause) for the PreparedSelector