oracle.ifs.server

Class SQLGeneration_Helper

java.lang.Object

oracle.ifs.server.SQLGeneration_Helper

public final class SQLGeneration_Helper
extends Object

The SQLGeneration_Helper class encapsulates functions needed to generate SQL statements, by the Search Classes.

Version:

1.0

Author:

Harish Butani

See Also:

SearchSpecification, SearchQualification, Search, SQLGenerator

(Unpublished)

Method Summary

Modifier and Type	Method and Description
boolean	applySecurity() Returns true if user doesn't have discover admin privileges.
static SQLGeneration_Helper	constructHelper(S_LibrarySession sess)
String	convertToSQLString(AttributeValue av)
String	convertToString(AttributeValue av)
void	createView(String viewName, String selectStatement, boolean replace)
protected static void	disposeHelper(S_LibrarySession session) Disposes any previously-constructed SQLGeneration_Helper for the specified session.
String	explainPlan(PreparedStatement planStatement, String planTable, String planName, boolean deleteRows)
S_ClassObjectData	getClassData(Long classId)
S_ClassObjectData	getClassData(String className)
String	getClassViewName(String className) Returns the view name for the specified ClassObject.
Long	getCurrentUser()
String	getDatabaseObjectName(String className, String attrName) Returns the databaseobjectname for the class and attribute.
long[]	getDateRangeValues(Date dateval, int compLevel) get low and high long value corresponding to a date value and a comparison level.
String	getFrqClause(long startFolderId, String poAlias, String relView) gets the SQL clause for a FolderRestrictQualification.
Localizer	getLocalizer() return the Localizer for the session.
Long	getPropertyAttributeId(int dataType)
String	getPropertyAttributeName(int dataType)
String	getRecursiveClause(String vName, String className, boolean isRecursive)
String	getSecurityClause(Long classId, String ownerValue)
String	getSecurityClause(String className, String ownerValue)
String	getSecurityClause(String vName, String className, String ownerValue)
String	getSelectList(Long classId, String tName, boolean qualifyColumns)
String	getSelectList(String className, String tName, boolean qualifyColumns)
S_LibrarySession	getSession() Get the session used by this instance.
String	getTableName(String className) Returns the tablename for the class
String	getViewName(Long classId)
String	getViewName(String className) Returns the approriate view to be used.
boolean	hasFolderIndexService() returns true if the service has a FolderIndexService
boolean	isLykeEnabled() Gets whether there is a ctxsubstr ("LYKE") index on the NAME attribute of PublicObject.
boolean	isPublicClass(Long classId)
boolean	isPublicClass(String className)
void	verifyHasLegalSyntax(String freeFormSQL) Wrapper for m_Session.verifyHasLegalSyntax
void	verifyHasSearchAccess(String classname)

Methods inherited from class java.lang.Object

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

Method Detail

constructHelper

public static SQLGeneration_Helper constructHelper(S_LibrarySession sess)

disposeHelper

protected static void disposeHelper(S_LibrarySession session)

Disposes any previously-constructed SQLGeneration_Helper for the specified session.

Parameters:

session - the session

(Unpublished)

getSession

public S_LibrarySession getSession()
                            throws IfsException

Get the session used by this instance.

Returns:

the session

Throws:

IfsException - if operation fails

(Unpublished)

getLocalizer

public Localizer getLocalizer()
                       throws IfsException

return the Localizer for the session.

Returns:

the Localizer

Throws:

IfsException - if operation fails

isLykeEnabled

public boolean isLykeEnabled()
                      throws IfsException

Gets whether there is a ctxsubstr ("LYKE") index on the NAME attribute of PublicObject.

Returns:

whether there is a LYKE index

Throws:

IfsException - if the operation fails

(Unpublished)

getViewName

public String getViewName(String className)
                   throws IfsException

Returns the approriate view to be used. For PublicObject and its subclasses, it returns the SecureView, for all other classes it returns the Normal View.

Throws:

IfsException

getViewName

public String getViewName(Long classId)
                   throws IfsException

Throws:

IfsException

getClassData

public S_ClassObjectData getClassData(String className)
                               throws IfsException

Throws:

IfsException

getClassData

public S_ClassObjectData getClassData(Long classId)
                               throws IfsException

Throws:

IfsException

isPublicClass

public boolean isPublicClass(String className)
                      throws IfsException

Throws:

IfsException

isPublicClass

public boolean isPublicClass(Long classId)
                      throws IfsException

Throws:

IfsException

getSelectList

public String getSelectList(String className,
                            String tName,
                            boolean qualifyColumns)
                     throws IfsException

Throws:

IfsException

getSelectList

public String getSelectList(Long classId,
                            String tName,
                            boolean qualifyColumns)
                     throws IfsException

Throws:

IfsException

getSecurityClause

public String getSecurityClause(String className,
                                String ownerValue)
                         throws IfsException

Throws:

IfsException

getSecurityClause

public String getSecurityClause(String vName,
                                String className,
                                String ownerValue)
                         throws IfsException

Throws:

IfsException

getSecurityClause

public String getSecurityClause(Long classId,
                                String ownerValue)
                         throws IfsException

Throws:

IfsException

getRecursiveClause

public String getRecursiveClause(String vName,
                                 String className,
                                 boolean isRecursive)
                          throws IfsException

Throws:

IfsException

getTableName

public String getTableName(String className)
                    throws IfsException

Returns the tablename for the class

Throws:

IfsException

createView

public void createView(String viewName,
                       String selectStatement,
                       boolean replace)
                throws IfsException

Throws:

IfsException

getPropertyAttributeName

public String getPropertyAttributeName(int dataType)
                                throws IfsException

Throws:

IfsException

getPropertyAttributeId

public Long getPropertyAttributeId(int dataType)
                            throws IfsException

Throws:

IfsException

convertToString

public String convertToString(AttributeValue av)
                       throws IfsException

Throws:

IfsException

convertToSQLString

public String convertToSQLString(AttributeValue av)
                          throws IfsException

Throws:

IfsException

getDatabaseObjectName

public String getDatabaseObjectName(String className,
                                    String attrName)
                             throws IfsException

Returns the databaseobjectname for the class and attribute. This method throws IfsExceptions if the requested class or attribute do not exist.

Throws:

IfsException

getClassViewName

public String getClassViewName(String className)
                        throws IfsException

Returns the view name for the specified ClassObject.

Parameters:

className - the name of the class

Returns:

the view name

Throws:

IfsException - if the operation fails

applySecurity

public boolean applySecurity()
                      throws IfsException

Returns true if user doesn't have discover admin privileges.

Throws:

IfsException

verifyHasSearchAccess

public void verifyHasSearchAccess(String classname)
                           throws IfsException

Throws:

IfsException

explainPlan

public String explainPlan(PreparedStatement planStatement,
                          String planTable,
                          String planName,
                          boolean deleteRows)
                   throws IfsException

Throws:

IfsException

getCurrentUser

public Long getCurrentUser()
                    throws IfsException

Throws:

IfsException

verifyHasLegalSyntax

public void verifyHasLegalSyntax(String freeFormSQL)
                          throws IfsException

Wrapper for m_Session.verifyHasLegalSyntax

Throws:

IfsException

(Unpublished)

getDateRangeValues

public long[] getDateRangeValues(Date dateval,
                                 int compLevel)
                          throws IfsException

get low and high long value corresponding to a date value and a comparison level. For example, if the date contains a value of '18-apr-96 17:30:50' and a comparison level of MONTH is specified, then the range returned is '01-apr-96 00:00:00.0' and '30-apr-96 23:59:59.999'

Parameters:

dateval - the data value

compLevel - the Date comparison level

Returns:

the low and high Date values converted to longs

Throws:

IfsException - if the operation fails

(Unpublished)

hasFolderIndexService

public boolean hasFolderIndexService()
                              throws IfsException

returns true if the service has a FolderIndexService

Returns:

true if the service has a FolderIndexService

Throws:

IfsException - if operation fails

(Unpublished)

getFrqClause

public String getFrqClause(long startFolderId,
                           String poAlias,
                           String relView)
                    throws IfsException

gets the SQL clause for a FolderRestrictQualification. Returns null if there is no Folder Index service registered.

Parameters:

startFolderId - the starting folder ID

poAlias - the alias used for the PublicObjects

relView - the folder path relationship view name

Returns:

the SQL clause for the FRQ

Throws:

IfsException - if operation fails

(Unpublished)