oracle.ifs.server

Class S_LibraryObjectSelector

java.lang.Object

oracle.ifs.server.S_LibraryObjectSelector

Direct Known Subclasses:

S_PublicObjectSelector, S_SchemaObjectSelector, S_SystemObjectSelector

public class S_LibraryObjectSelector
extends Object

A S_LibraryObjectSelector is used to perform simple select operations.

See Also:

S_LibraryObject

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
protected Long	m_ClassId
protected SortSpecification	m_IdSortSpecification
protected SortSpecification	m_NameSortSpecification
protected S_LibrarySession	m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	S_LibraryObjectSelector(S_LibrarySession session, Long classId) Constructs a S_LibraryObjectSelector object, with the classId that it is servicing specified.

Method Summary

Modifier and Type	Method and Description
protected void	closeCursor(S_LibraryObjectCursor cursor) Best effort to close a cursor.
protected void	ensureDefaultClass(SortSpecification sort) Ensure that the specified SortSpecification has a valid default class set.
protected S_LibraryObjectData	findObjectById(Long id) Find an object by ID.
protected String	generateStatementName(String classname, SortSpecification sort, String stmtSuffix) Generates a statement name.
protected String	generateStatementName(String classname, String stmtSuffix) Generates a statement name.
protected String	generateStatementName(String classname, String relname, SortSpecification sort, String stmtSuffix) Generates a statement name.
protected String	generateStatementName(String classname, String relname, String stmtSuffix) Generates a statement name.
protected S_ClassObjectData	getClassData() Gets the Data object.
protected S_ClassObjectData	getClassData(Long classId) Gets the ClassData object for the specified class ID.
protected Long	getClassId() Gets the ID of the class this selector is servicing.
protected String	getClassName() Get the class's name that this instance services.
protected LibraryQueryStatement	getComplexQueryStatement(LibraryConnection lconn, PreparedSelectorSpecification pss, boolean countOnly) Gets a statement for a complex query specified by a PreparedSelectorSpecification.
protected long	getCountFromResultSet(ResultSet rset) Gets the count from a ResultSet opened with "select count()" query.
protected SortSpecification	getIdSortSpecification() Returns the ID Sort Specification to be used by this selector.
protected SortSpecification	getNameSortSpecification() Returns the Name Sort Specification to be used by this selector.
protected String	getResourceString(String key) Returns a resource string from the Resource Bundle.
protected LibraryQueryStatement	getSearchResultQueryStatement(LibraryConnection lconn, PreparedSelectorSpecification pss) Gets a statement for a query for "search results", meaning specific columns are selected from the specified search targets.
protected S_LibraryService	getService() Returns the S_LibraryService which created the S_LibrarySession from which this object was created.
protected LibraryQueryStatement	getSimpleCountQueryStatement(String key, LibraryConnection lconn, String whereClause, int maxCopies) Gets a statement for a simple "select count()" query.
protected LibraryQueryStatement	getSimpleQueryStatement(String key, LibraryConnection lconn, String whereClause, SortSpecification sort, int maxCopies) Gets a statement for a simple query.
protected String	getStatementSuffix() Returns a statement suffix appropriate to the current session Admin mode.
protected S_LibraryObjectData	nextItem(S_LibraryObjectCursor cursor) Gets the next item from a cursor.
protected Vector	selectAllObjects() Select all objects.
protected Vector	selectArrayReferencingObjects(AttributeValue referencedValue, Long attributeId, SortSpecification sort) Selects objects based an array attribute referencing the specified object.
protected long	selectArrayReferencingObjectsCount(AttributeValue referencedValue, Long attributeId) Selects the count based an array attribute referencing the specified object.
protected S_LibraryObjectCursor	selectArrayReferencingObjectsCursor(AttributeValue referencedValue, Long attributeId, SortSpecification sort) Selects cursor for query based an array attribute referencing the specified object.
protected long	selectCount(PreparedSelectorSpecification pss) Perform a complex "select count()" query for S_PreparedSelector, using inputs from the specified PreparedSelectorSpecification.
protected long	selectCount(String whereClause) Perform a "select count()" query.
protected S_LibraryObjectData	selectObjectById(Long id) Selects an object by ID.
protected Vector	selectObjects(PreparedSelectorSpecification pss) Select objects for a S_PreparedSelector, using inputs from the specified PreparedSelectorSpecification.
protected Vector	selectObjects(String whereClause, SortSpecification sort) Select objects for a one-time use S_Selector.
protected Vector	selectObjects(String whereClause, SortSpecification sort, int maxItemCount) Select objects for a one-time use S_Selector.
Vector	selectObjectsByMasterId(Long masterId, String masterAttrName, SortSpecification sort) Selects objects for a detail table, using the specified master ID.
protected Vector	selectObjectsByStringAttribute(String attrValue, String masterAttrName, SortSpecification sort) Selects objects by a String attribute.
protected long	selectObjectsCountByMasterId(Long masterId, String masterAttrName) Selects count of objects by master ID.
protected S_LibraryObjectCursor	selectObjectsCursor(String whereClause, SortSpecification sort) Open a cursor.
protected S_LibraryObjectCursor	selectObjectsCursorByMasterId(Long masterId, String masterAttrName, SortSpecification sort) Selects cursor for selecting objects by master ID.
protected S_LibraryObjectCursor	selectObjectsCursorByStringAttribute(String attrValue, String masterAttrName, SortSpecification sort) Selects cursor for selecting objects by string attribute.
protected boolean	selectObjectsExistByMasterId(Long masterId, String masterAttrName) Checks for the existence of an object by master ID.
protected AttributeValueTable[]	selectResults(PreparedSelectorSpecification pss) Select results for a S_PreparedSelector, using inputs from the specified PreparedSelectorSpecification.

Methods inherited from class java.lang.Object

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

Field Detail

m_Session

protected S_LibrarySession m_Session

m_ClassId

protected Long m_ClassId

m_IdSortSpecification

protected SortSpecification m_IdSortSpecification

m_NameSortSpecification

protected SortSpecification m_NameSortSpecification

Constructor Detail

S_LibraryObjectSelector

protected S_LibraryObjectSelector(S_LibrarySession session,
                                  Long classId)
                           throws IfsException

Constructs a S_LibraryObjectSelector object, with the classId that it is servicing specified.

Parameters:

session - session context

classId - the class Id that the selector is serving

Throws:

IfsException - if the operation fails

Method Detail

getClassId

protected Long getClassId()

Gets the ID of the class this selector is servicing.

Returns:

the associated Class ID

getClassData

protected S_ClassObjectData getClassData()
                                  throws IfsException

Gets the Data object.

Returns:

the object's class's Data object for the class that this instance services.

Throws:

IfsException - if operation fails.

getClassData

protected S_ClassObjectData getClassData(Long classId)
                                  throws IfsException

Gets the ClassData object for the specified class ID.

Parameters:

classId - the class ID

Returns:

the object's class's Data object for specified class

Throws:

IfsException - if operation fails.

getClassName

protected String getClassName()
                       throws IfsException

Get the class's name that this instance services.

Returns:

the class's name

Throws:

IfsException - if operation fails.

getService

protected S_LibraryService getService()
                               throws IfsException

Returns the S_LibraryService which created the S_LibrarySession from which this object was created.

Returns:

the S_LibraryService from which this object was created.

Throws:

IfsException - if operation fails.

getResourceString

protected String getResourceString(String key)
                            throws MissingResourceException,
                                   IfsException

Returns a resource string from the Resource Bundle.

Returns:

a String from the Resource Bundle.

Throws:

MissingResourceException - if the String cannot be found.

IfsException - if operation fails.

getNameSortSpecification

protected SortSpecification getNameSortSpecification()
                                              throws IfsException

Returns the Name Sort Specification to be used by this selector.

Returns:

a sort by name Sort specification that is cached by this instance

Throws:

IfsException - if operation fails.

getIdSortSpecification

protected SortSpecification getIdSortSpecification()
                                            throws IfsException

Returns the ID Sort Specification to be used by this selector.

Returns:

a sort by ID Sort specification that is cached by this instance

Throws:

IfsException - if operation fails.

ensureDefaultClass

protected void ensureDefaultClass(SortSpecification sort)
                           throws IfsException

Ensure that the specified SortSpecification has a valid default class set. For now, just set it to this instance's class if it is currently unset.

Parameters:

sort - a Sort specification

Throws:

IfsException - if operation fails.

selectAllObjects

protected Vector selectAllObjects()
                           throws IfsException

Select all objects.

Returns:

Vector of S_LibraryObjectData

Throws:

IfsException - if operation fails.

selectObjects

protected Vector selectObjects(String whereClause,
                               SortSpecification sort)
                        throws IfsException

Select objects for a one-time use S_Selector.

Indicates no constraint for the maximum item count.

Parameters:

whereClause - select where clause

sort - the sort specification

Returns:

Vector of S_LibraryObjectData

Throws:

IfsException - if the operation fails.

selectObjects

protected Vector selectObjects(String whereClause,
                               SortSpecification sort,
                               int maxItemCount)
                        throws IfsException

Select objects for a one-time use S_Selector.

Parameters:

whereClause - select where clause

sort - the sort specification

maxItemCount - the maximum number of items to select

Returns:

Vector of S_LibraryObjectData

Throws:

IfsException - if the operation fails.

selectObjects

protected Vector selectObjects(PreparedSelectorSpecification pss)
                        throws IfsException

Select objects for a S_PreparedSelector, using inputs from the specified PreparedSelectorSpecification.

Parameters:

pss - the PreparedSelectorSpecification which holds all query settings

Returns:

Vector of S_LibraryObjectData

Throws:

IfsException - if the operation fails.

selectResults

protected AttributeValueTable[] selectResults(PreparedSelectorSpecification pss)
                                       throws IfsException

Select results for a S_PreparedSelector, using inputs from the specified PreparedSelectorSpecification.

Parameters:

pss - the PreparedSelectorSpecification which holds all query settings

Returns:

the array of results (one AttributeValueTable per row)

Throws:

IfsException - if the operation fails.

selectObjectsCursor

protected S_LibraryObjectCursor selectObjectsCursor(String whereClause,
                                                    SortSpecification sort)
                                             throws IfsException

Open a cursor.

Parameters:

whereClause - search where clause

sort - the sort specification

Returns:

the cursor

Throws:

IfsException - if the operation fails.

selectCount

protected long selectCount(String whereClause)
                    throws IfsException

Perform a "select count()" query.

Parameters:

whereClause - search where clause

Returns:

the count that results

Throws:

IfsException - if the operation fails.

selectCount

protected long selectCount(PreparedSelectorSpecification pss)
                    throws IfsException

Perform a complex "select count()" query for S_PreparedSelector, using inputs from the specified PreparedSelectorSpecification.

Parameters:

pss - the PreparedSelectorSpecification which holds all query settings

Returns:

the row count

Throws:

IfsException - if the operation fails.

getSimpleQueryStatement

protected LibraryQueryStatement getSimpleQueryStatement(String key,
                                                        LibraryConnection lconn,
                                                        String whereClause,
                                                        SortSpecification sort,
                                                        int maxCopies)
                                                 throws IfsException

Gets a statement for a simple query.

Parameters:

key - statement key

lconn - connection context

whereClause - search where clause

sort - sort specification

maxCopies - max number of statement copies to keep

Returns:

the statement

Throws:

IfsException - if the operation fails.

getComplexQueryStatement

protected LibraryQueryStatement getComplexQueryStatement(LibraryConnection lconn,
                                                         PreparedSelectorSpecification pss,
                                                         boolean countOnly)
                                                  throws IfsException

Gets a statement for a complex query specified by a PreparedSelectorSpecification.

Parameters:

lconn - connection context

pss - the PreparedSelectorSpecification containing all query settings

countOnly - indicates if this is for a select count(*) query

Returns:

the statement

Throws:

IfsException - if the operation fails.

getSearchResultQueryStatement

protected LibraryQueryStatement getSearchResultQueryStatement(LibraryConnection lconn,
                                                              PreparedSelectorSpecification pss)
                                                       throws IfsException

Gets a statement for a query for "search results", meaning specific columns are selected from the specified search targets.

Parameters:

lconn - connection context

pss - the PreparedSelectorSpecification containing all query settings

Returns:

the statement

Throws:

IfsException - if the operation fails.

getSimpleCountQueryStatement

protected LibraryQueryStatement getSimpleCountQueryStatement(String key,
                                                             LibraryConnection lconn,
                                                             String whereClause,
                                                             int maxCopies)
                                                      throws IfsException

Gets a statement for a simple "select count()" query.

Parameters:

key - statement key

lconn - connection context

whereClause - search where clause

maxCopies - max number of statement copies to keep

Returns:

the statement

Throws:

IfsException - if the operation fails.

selectObjectById

protected S_LibraryObjectData selectObjectById(Long id)
                                        throws IfsException

Selects an object by ID.

Parameters:

id - object ID.

Returns:

the data for the selected object.

Throws:

IfsException - if the operation fails.

findObjectById

protected S_LibraryObjectData findObjectById(Long id)
                                      throws IfsException

Find an object by ID.

Parameters:

id - object ID.

Returns:

the data for the selected object, or null if data cannot be selected

Throws:

IfsException - if the operation fails.

selectObjectsByMasterId

public Vector selectObjectsByMasterId(Long masterId,
                                      String masterAttrName,
                                      SortSpecification sort)
                               throws IfsException

Selects objects for a detail table, using the specified master ID.

Parameters:

masterId - the master ID

masterAttrName - the attribute name for the master ID reference

sort - the sort specification

Returns:

the vector of object data

Throws:

IfsException - if the operation fails.

selectArrayReferencingObjects

protected Vector selectArrayReferencingObjects(AttributeValue referencedValue,
                                               Long attributeId,
                                               SortSpecification sort)
                                        throws IfsException

Selects objects based an array attribute referencing the specified object.

Only works for object-type array attributes.

Parameters:

referencedValue - the value being searched for

attributeId - the array attribute

sort - the sort specification

Returns:

the vector of object data

Throws:

IfsException - if the operation fails.

selectArrayReferencingObjectsCount

protected long selectArrayReferencingObjectsCount(AttributeValue referencedValue,
                                                  Long attributeId)
                                           throws IfsException

Selects the count based an array attribute referencing the specified object.

Only works for object-type array attributes.

Parameters:

referencedValue - the value being searched for

attributeId - the array attribute

Returns:

the resulting count

Throws:

IfsException - if the operation fails.

selectObjectsByStringAttribute

protected Vector selectObjectsByStringAttribute(String attrValue,
                                                String masterAttrName,
                                                SortSpecification sort)
                                         throws IfsException

Selects objects by a String attribute.

Parameters:

attrValue - the value being searched for

masterAttrName - the string attribute

sort - the sort specification

Returns:

the vector of object data

Throws:

IfsException - if the operation fails.

selectObjectsCountByMasterId

protected long selectObjectsCountByMasterId(Long masterId,
                                            String masterAttrName)
                                     throws IfsException

Selects count of objects by master ID.

Parameters:

masterId - the master ID value

masterAttrName - the master attribute name

Returns:

the resulting count

Throws:

IfsException - if the operation fails.

selectObjectsExistByMasterId

protected boolean selectObjectsExistByMasterId(Long masterId,
                                               String masterAttrName)
                                        throws IfsException

Checks for the existence of an object by master ID.

Parameters:

masterId - the master ID value

masterAttrName - the master attribute name

Returns:

true if an object exists; false otherwise

Throws:

IfsException - if the operation fails.

selectObjectsCursorByMasterId

protected S_LibraryObjectCursor selectObjectsCursorByMasterId(Long masterId,
                                                              String masterAttrName,
                                                              SortSpecification sort)
                                                       throws IfsException

Selects cursor for selecting objects by master ID.

Parameters:

masterId - the master ID value

masterAttrName - the master attribute name

sort - the sort specification

Returns:

the cursor

Throws:

IfsException - if the operation fails.

selectArrayReferencingObjectsCursor

protected S_LibraryObjectCursor selectArrayReferencingObjectsCursor(AttributeValue referencedValue,
                                                                    Long attributeId,
                                                                    SortSpecification sort)
                                                             throws IfsException

Selects cursor for query based an array attribute referencing the specified object.

Only works for object-type array attributes.

Parameters:

referencedValue - the value being searched for

attributeId - the array attribute

sort - the sort specification

Returns:

the cursor

Throws:

IfsException - if the operation fails.

selectObjectsCursorByStringAttribute

protected S_LibraryObjectCursor selectObjectsCursorByStringAttribute(String attrValue,
                                                                     String masterAttrName,
                                                                     SortSpecification sort)
                                                              throws IfsException

Selects cursor for selecting objects by string attribute.

Parameters:

attrValue - the string attribute value

masterAttrName - the master attribute name

sort - the sort specification

Returns:

the cursor

Throws:

IfsException - if the operation fails.

nextItem

protected S_LibraryObjectData nextItem(S_LibraryObjectCursor cursor)
                                throws IfsException

Gets the next item from a cursor.

Parameters:

cursor - the cursor

Returns:

the data for the next item

Throws:

IfsException - if the operation fails.

getCountFromResultSet

protected long getCountFromResultSet(ResultSet rset)
                              throws IfsException

Gets the count from a ResultSet opened with "select count()" query.

Parameters:

rset - the ResultSet

Returns:

the count

Throws:

IfsException - if the operation fails.

closeCursor

protected void closeCursor(S_LibraryObjectCursor cursor)

Best effort to close a cursor.

Parameters:

cursor - the cursor to close.

getStatementSuffix

protected String getStatementSuffix()
                             throws IfsException

Returns a statement suffix appropriate to the current session Admin mode.

Returns:

the suffix

Throws:

IfsException - if the operation fails.

generateStatementName

protected final String generateStatementName(String classname,
                                             String stmtSuffix)
                                      throws IfsException

Generates a statement name.

Parameters:

classname - the class name

stmtSuffix - the statement suffix

Returns:

the statement name

Throws:

IfsException - if the operation fails.

generateStatementName

protected final String generateStatementName(String classname,
                                             String relname,
                                             String stmtSuffix)
                                      throws IfsException

Generates a statement name.

Parameters:

classname - the class name

relname - the relation name; null if not applicable

stmtSuffix - the statement suffix

Returns:

the statement name

Throws:

IfsException - if the operation fails.

generateStatementName

protected final String generateStatementName(String classname,
                                             SortSpecification sort,
                                             String stmtSuffix)
                                      throws IfsException

Generates a statement name.

Parameters:

classname - the class name

sort - the sort specification; can be null

stmtSuffix - the statement suffix

Returns:

the statement name

Throws:

IfsException - if the operation fails.

generateStatementName

protected final String generateStatementName(String classname,
                                             String relname,
                                             SortSpecification sort,
                                             String stmtSuffix)
                                      throws IfsException

Generates a statement name.

Parameters:

classname - the class name

relname - the relation name; null if not applicable

sort - the sort specification; can be null

stmtSuffix - the statement suffix

Returns:

the statement name

Throws:

IfsException - if the operation fails.