FolderIndexService (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.server.FolderIndexService

All Implemented Interfaces:

SubService

Direct Known Subclasses:

TieFolderIndexService
```
public class FolderIndexService
extends Object
implements SubService
```
A FolderIndexService manages the iFS folder index, and updates it transactionally as the folder hierarchy changes.

Version:

1.0

Author:

Dave Long

(Unpublished)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DEFERRED_UPDATE_SEQ_NAME` The name of the folder index deferred update sequence.
`static String`	`DEFERRED_UPDATE_TABLE_NAME` The name of the folder index deferred update table.
`protected static String`	`FOLDER_TABLE_NAME` The name of the folder table.
`static String`	`FPR_TABLE_NAME` The name of the FolderPathRelationship view.
`protected boolean`	`m_CreationDeferred` Indicates whether or not the creation of the index has been deferred and has not yet completed.
`protected Long`	`m_FolderIndexPropertyBundleClassId` The Class ID of the Folder Index Properties PropertyBundle
`protected Long`	`m_FolderIndexPropertyBundleId` The ID of the Folder Index Properties PropertyBundle
`protected int`	`m_MaxLevel` The maximum level.
`protected S_LibraryService`	`m_Service` The parent library service
`protected int`	`m_UpdateMode` The update mode for this service
`protected boolean`	`m_UseExistsClause` Should FRQ's use an "exists" clause?
`static String`	`MAP_INDEX_LEFT` The name of the index on the leftid.
`static String`	`MAP_INDEX_RIGHT` The name of the index on the rightid.
`protected static int`	`MAP_LEVEL_MAIN`
`static String`	`MAP_TABLE_NAME` The name of the folder index table.
`static String`	`PARAM_TABLE_NAME` The name of the folder index parameter table.
`protected static int`	`PARAMETER_KEY_MAP_CREATION_DEFERRED` The parameter key used to indicate whether the creation of the map is not yet complete.
`protected static int`	`PARAMETER_KEY_MAP_UPDATE_MODE` The parameter key used to indicate whether the map is updated synchronously or asynchronously.
`protected static int`	`PARAMETER_KEY_MAXLEVEL` The parameter key used to hold the maximum number of levels.
`protected static int`	`PARAMETER_KEY_PARTIALLY_CREATED` The parameter key used to indicate that the index is only partially created.
`protected static int`	`PARAMETER_VALUE_MAP_UPDATE_MODE_ASYNC` The value of the PARAMETER_KEY_MAP_UPDATE_MODE parameter that indicates the map is updated asynchronously.
`protected static int`	`PARAMETER_VALUE_MAP_UPDATE_MODE_NONE` The value of the PARAMETER_KEY_MAP_UPDATE_MODE parameter that indicates the map does not exist.
`protected static int`	`PARAMETER_VALUE_MAP_UPDATE_MODE_SYNC` The value of the PARAMETER_KEY_MAP_UPDATE_MODE parameter that indicates the map is updated synchronously.
`static String`	`REL_TABLE_NAME` The name of the Relationship table.
`protected static String`	`STATEMENT_CHECK_AT_LEVEL`
`protected static String`	`STATEMENT_COUNT_OF_DIRECT_CHILDREN`
`protected static String`	`STATEMENT_CYCLE_CHECK`
`protected static String`	`STATEMENT_DELETE_ALL_BY_LEFT`
`protected static String`	`STATEMENT_DELETE_DEFERRED_UPDATE_ROW`
`protected static String`	`STATEMENT_DELETE_MAP_ROW`
`protected static String`	`STATEMENT_DELETE_SELF_ROW`
`protected static String`	`STATEMENT_FOLDERS_WITH_MANY_PARENTS`
`protected static String`	`STATEMENT_GET_DIRECT_PARENTS`
`protected static String`	`STATEMENT_INSERT_DEFERRED_UPDATE_ROW`
`protected static String`	`STATEMENT_INSERT_MAP_ROW`
`protected static String`	`STATEMENT_INSERT_MAP_ROWS`
`protected static String`	`STATEMENT_INSERT_SELF_ROW`
`protected static String`	`STATEMENT_LOCK_PARAMETER`
`protected static String`	`STATEMENT_PROMOTE_ADD_DESCENDANTS`
`protected static String`	`STATEMENT_PROMOTE_ANCESTORS`
`protected static String`	`STATEMENT_PROMOTE_DESCENDANTS`
`protected static String`	`STATEMENT_SELECT_DEFERRED_UPDATE_ROWS`
`protected static String`	`STATEMENT_SELECT_PARAMETER`
`protected static String`	`STATEMENT_SELECT_ROWS_FOR_DELETE`
`protected static String`	`STATEMENT_SHOW_MAP`
`protected static String`	`STATEMENT_UPDATE_SELF_ROW`

Constructor Summary

Constructors
Modifier Constructor and Description

protected FolderIndexService(S_LibraryService service)
Construct a FolderIndexService.

Constructors
Modifier	Constructor and Description
`protected`	`FolderIndexService(S_LibraryService service)` Construct a FolderIndexService.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addToFolder(S_LibrarySession sess, long parentid, long childid)` Update the index to reflect a child folder being added to a parent folder.
`protected void`	`addToFolderNow(S_LibrarySession sess, long parentid, long childid)` Update the index to reflect a child folder being added to a parent folder, without deferring.
`protected void`	`applyDeferredUpdate(S_LibrarySession sess, FolderIndexDeferredUpdate fidu)`
`protected void`	`breakCycle(S_LibrarySession sess, long leftId, long rightId)`
`protected void`	`changeUpdateMode(S_LibrarySession sess, int newMode)`
`protected void`	`completeIndexCreation(S_LibrarySession sess, boolean creationDeferred)`
`protected PreparedStatement`	`constructPreparedStatement(LibraryConnection lc, Connection conn, String key, String stmt)`
`protected void`	`createDeferredUpdate(S_LibrarySession sess, int operationType, long leftId, long rightId, int level)`
`protected void`	`createInitialDeferredEntries(S_LibrarySession sess)`
`protected void`	`createInitialSelfRows(S_LibrarySession sess)`
`protected void`	`createMapSelfRow(S_LibrarySession sess, LibraryConnection lc, Connection conn, long id, long leftSource, int maplevel)`
`protected boolean`	`deferOperation(S_LibrarySession sess)`
`protected void`	`deleteDeferredUpdate(S_LibrarySession sess, long id)`
`protected void`	`deleteMapParameterRow(LibraryConnection lc, Connection conn, long key)`
`protected void`	`deleteMapSelfRow(S_LibrarySession sess, LibraryConnection lc, Connection conn, long id, int maplevel)`
`protected int`	`determineMapLevel(LibraryConnection lc, Connection conn, int maxLevel, long folderId)`
`void`	`dispose()` Terminate this subservice.
`protected HashMap`	`getDirectParents(S_LibrarySession sess, int level, Vector folderVector)` Returns the direct parents of all the folders that are in the given vector.
`protected int`	`getFolderIndexLock(LibraryConnection lc, Connection conn)`
`protected Long`	`getFolderIndexPropertyBundleClassId(S_LibrarySession sess)`
`protected Long`	`getFolderIndexPropertyBundleId(S_LibrarySession sess)`
`protected Long[]`	`getFoldersNeedingPromotion(S_LibrarySession sess, int level, int maxParentsThreshold, int maxChildrenThreshold)` Returns array of Long objects that hold the id of the folders at the current level that need promotion, in order to avoid explosion of rows in the odmz_folderindex because of multiply linked folders.
`protected Vector`	`getFoldersWithParentCountAboveThreshold(S_LibrarySession sess, int level, int parentThreshhold)` Returns Vector of folders whose direct parent count is greater than the max parent threshold.
`protected String`	`getFrqClause(S_LibrarySession sess, long topFolderId, String poAlias, String relView)` Gets a Folder-restricted search clause (FRQ).
`protected String`	`getFrqClause(S_LibrarySession sess, long topFolderId, String poAlias, String relView, Boolean useExists)` Gets a Folder-restricted search clause (FRQ).
`protected String`	`getFrqExistsClause(long topFolderId, int topMapLevel, int bottomMapLevel, String poAlias, String relView)`
`protected String`	`getFrqExistsClause(S_LibrarySession sess, long topFolderId, String poAlias, String relView)` Gets a Folder-restricted search clause (FRQ) using the EXISTS syntax.
`protected String`	`getFrqInClause(long topFolderId, int topMapLevel, int bottomMapLevel, String relView)`
`protected String`	`getFrqInClause(S_LibrarySession sess, long topFolderId, String poAlias, String relView)` Gets a Folder-restricted search clause (FRQ) using the IN syntax.
`protected int`	`getMapParameterRow(LibraryConnection lc, Connection conn, int paramKey, boolean shouldLock)`
`protected int`	`getMaxLevel(LibraryConnection lc, Connection conn)`
`protected int`	`getMaxLevel(LibraryConnection lc, Connection conn, boolean shouldLock)`
`int`	`getMaxLevel(S_LibrarySession sess)` Gets the Max level setting for the Folder index.
`protected PreparedStatement`	`getPreparedStatement(LibraryConnection lc, Connection conn, String key)`
`protected int`	`getUpdateMode(LibraryConnection lc, Connection conn)`
`protected void`	`init()` Initialize this subservice.
`protected void`	`initializeTables(S_LibrarySession sess, int maxLevels)`
`protected void`	`insertMapParameterRow(LibraryConnection lc, Connection conn, long key, long value)`
`protected void`	`insertReferences(S_LibrarySession sess, LibraryConnection lc, Connection conn, long parentid, long childid, int maplevel)`
`protected boolean`	`isChildCountAboveThreshold(S_LibrarySession sess, Long folderId, int childCountThreshold)` Returns true if the given folder has more children than the threshold.
`protected boolean`	`isCreationDeferred(LibraryConnection lc, Connection conn)`
`protected boolean`	`isCreationDeferred(S_LibrarySession sess)`
`protected boolean`	`isCycleCheckViolation(S_LibrarySession sess, LibraryConnection lc, Connection conn, long parentid, long childid, int parentMapLevel, int childMapLevel)`
`protected boolean`	`isFolderAtMaplevel(LibraryConnection lc, Connection conn, long folderId, int maplevel)`
`protected boolean`	`isIndexPartiallyCreated(LibraryConnection lc, Connection conn)`
`protected boolean`	`isValidLevel(int level, int maxLevel)`
`protected void`	`postEvent(S_LibrarySession sess)`
`protected void`	`promoteFolder(S_LibrarySession sess, LibraryConnection lc, Connection conn, int maxLevel, long folderId, int newLevel)`
`protected void`	`promoteFolder(S_LibrarySession sess, long folderId, int newLevel)` Promote a folder to the specified level.
`protected void`	`promoteFolderNow(S_LibrarySession sess, long folderId, int newLevel)` Promote a folder to the specified level, without deferring.
`protected void`	`promoteFolderOneLevel(S_LibrarySession sess, LibraryConnection lc, Connection conn, HashMap promotedMap, long folderId, int currentLevel)`
`protected void`	`promoteSingleFolderOneLevel(S_LibrarySession sess, LibraryConnection lc, Connection conn, long folderId, int currentLevel)`
`protected void`	`registerNewFolder(S_LibrarySession sess, long id)` Register a new folder at the main level.
`protected void`	`registerNewFolder(S_LibrarySession sess, long id, int level)` Register a new folder at the specified level.
`protected void`	`registerNewFolderNow(S_LibrarySession sess, long id, int level)` Register a new folder at the specified level, without deferring.
`protected void`	`removeFromFolder(S_LibrarySession sess, long parentid, long childid)` Update the index to reflect a child folder being removed from a parent folder.
`protected void`	`removeFromFolderNow(S_LibrarySession sess, long parentid, long childid)` Update the index to reflect a child folder being removed from a parent folder, without deferring.
`protected void`	`removeReferences(S_LibrarySession sess, LibraryConnection lc, Connection conn, long parentid, long childid, int maplevel)`
`protected int`	`resetFolderIndex(S_LibrarySession sess)`
`protected Vector`	`selectDeferredUpdates(S_LibrarySession sess, int maxItems)`
`protected void`	`setMaxLevel(LibraryConnection lc, Connection conn, int maxLevel)`
`protected void`	`setUpdateMode(LibraryConnection lc, Connection conn, int updateMode)`
`protected void`	`truncateTables(S_LibrarySession sess)`
`protected void`	`unregisterFreedFolder(S_LibrarySession sess, long id)` Unregister a folder that is being freed.
`protected void`	`unregisterFreedFolderNow(S_LibrarySession sess, long id)` Unregister a folder that is being freed, without deferring.
`protected void`	`updateMapSelfRow(S_LibrarySession sess, LibraryConnection lc, Connection conn, long id, long tempvalue, int maplevel)`
`protected void`	`verifyValidLevel(int level, int maxLevel)`

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

Field Detail
- FPR_TABLE_NAME
```
public static final String FPR_TABLE_NAME
```
  The name of the FolderPathRelationship view.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- REL_TABLE_NAME
```
public static final String REL_TABLE_NAME
```
  The name of the Relationship table.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- MAP_TABLE_NAME
```
public static final String MAP_TABLE_NAME
```
  The name of the folder index table.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- PARAM_TABLE_NAME
```
public static final String PARAM_TABLE_NAME
```
  The name of the folder index parameter table.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- DEFERRED_UPDATE_TABLE_NAME
```
public static final String DEFERRED_UPDATE_TABLE_NAME
```
  The name of the folder index deferred update table.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- DEFERRED_UPDATE_SEQ_NAME
```
public static final String DEFERRED_UPDATE_SEQ_NAME
```
  The name of the folder index deferred update sequence.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- MAP_INDEX_LEFT
```
public static final String MAP_INDEX_LEFT
```
  The name of the index on the leftid.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- MAP_INDEX_RIGHT
```
public static final String MAP_INDEX_RIGHT
```
  The name of the index on the rightid.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- FOLDER_TABLE_NAME
```
protected static final String FOLDER_TABLE_NAME
```
  The name of the folder table.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- PARAMETER_KEY_MAXLEVEL
```
protected static final int PARAMETER_KEY_MAXLEVEL
```
  The parameter key used to hold the maximum number of levels. Currently has the value 1.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- PARAMETER_KEY_PARTIALLY_CREATED
```
protected static final int PARAMETER_KEY_PARTIALLY_CREATED
```
  The parameter key used to indicate that the index is only partially created. Currently has the value 2.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- PARAMETER_KEY_MAP_UPDATE_MODE
```
protected static final int PARAMETER_KEY_MAP_UPDATE_MODE
```
  The parameter key used to indicate whether the map is updated synchronously or asynchronously.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- PARAMETER_KEY_MAP_CREATION_DEFERRED
```
protected static final int PARAMETER_KEY_MAP_CREATION_DEFERRED
```
  The parameter key used to indicate whether the creation of the map is not yet complete.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- PARAMETER_VALUE_MAP_UPDATE_MODE_NONE
```
protected static final int PARAMETER_VALUE_MAP_UPDATE_MODE_NONE
```
  The value of the PARAMETER_KEY_MAP_UPDATE_MODE parameter that indicates the map does not exist. Currently has the value 0.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- PARAMETER_VALUE_MAP_UPDATE_MODE_SYNC
```
protected static final int PARAMETER_VALUE_MAP_UPDATE_MODE_SYNC
```
  The value of the PARAMETER_KEY_MAP_UPDATE_MODE parameter that indicates the map is updated synchronously. Currently has the value 1.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- PARAMETER_VALUE_MAP_UPDATE_MODE_ASYNC
```
protected static final int PARAMETER_VALUE_MAP_UPDATE_MODE_ASYNC
```
  The value of the PARAMETER_KEY_MAP_UPDATE_MODE parameter that indicates the map is updated asynchronously. Currently has the value 2.
  
  See Also:
  
  Constant Field Values
  
  (Unpublished)
- STATEMENT_SELECT_ROWS_FOR_DELETE
```
protected static final String STATEMENT_SELECT_ROWS_FOR_DELETE
```
  See Also:
  
  Constant Field Values
- STATEMENT_SELECT_PARAMETER
```
protected static final String STATEMENT_SELECT_PARAMETER
```
  See Also:
  
  Constant Field Values
- STATEMENT_SELECT_DEFERRED_UPDATE_ROWS
```
protected static final String STATEMENT_SELECT_DEFERRED_UPDATE_ROWS
```
  See Also:
  
  Constant Field Values
- STATEMENT_INSERT_SELF_ROW
```
protected static final String STATEMENT_INSERT_SELF_ROW
```
  See Also:
  
  Constant Field Values
- STATEMENT_INSERT_MAP_ROW
```
protected static final String STATEMENT_INSERT_MAP_ROW
```
  See Also:
  
  Constant Field Values
- STATEMENT_INSERT_MAP_ROWS
```
protected static final String STATEMENT_INSERT_MAP_ROWS
```
  See Also:
  
  Constant Field Values
- STATEMENT_INSERT_DEFERRED_UPDATE_ROW
```
protected static final String STATEMENT_INSERT_DEFERRED_UPDATE_ROW
```
  See Also:
  
  Constant Field Values
- STATEMENT_UPDATE_SELF_ROW
```
protected static final String STATEMENT_UPDATE_SELF_ROW
```
  See Also:
  
  Constant Field Values
- STATEMENT_DELETE_SELF_ROW
```
protected static final String STATEMENT_DELETE_SELF_ROW
```
  See Also:
  
  Constant Field Values
- STATEMENT_DELETE_MAP_ROW
```
protected static final String STATEMENT_DELETE_MAP_ROW
```
  See Also:
  
  Constant Field Values
- STATEMENT_DELETE_ALL_BY_LEFT
```
protected static final String STATEMENT_DELETE_ALL_BY_LEFT
```
  See Also:
  
  Constant Field Values
- STATEMENT_DELETE_DEFERRED_UPDATE_ROW
```
protected static final String STATEMENT_DELETE_DEFERRED_UPDATE_ROW
```
  See Also:
  
  Constant Field Values
- STATEMENT_PROMOTE_DESCENDANTS
```
protected static final String STATEMENT_PROMOTE_DESCENDANTS
```
  See Also:
  
  Constant Field Values
- STATEMENT_PROMOTE_ANCESTORS
```
protected static final String STATEMENT_PROMOTE_ANCESTORS
```
  See Also:
  
  Constant Field Values
- STATEMENT_PROMOTE_ADD_DESCENDANTS
```
protected static final String STATEMENT_PROMOTE_ADD_DESCENDANTS
```
  See Also:
  
  Constant Field Values
- STATEMENT_CHECK_AT_LEVEL
```
protected static final String STATEMENT_CHECK_AT_LEVEL
```
  See Also:
  
  Constant Field Values
- STATEMENT_CYCLE_CHECK
```
protected static final String STATEMENT_CYCLE_CHECK
```
  See Also:
  
  Constant Field Values
- STATEMENT_LOCK_PARAMETER
```
protected static final String STATEMENT_LOCK_PARAMETER
```
  See Also:
  
  Constant Field Values
- STATEMENT_SHOW_MAP
```
protected static final String STATEMENT_SHOW_MAP
```
  See Also:
  
  Constant Field Values
- STATEMENT_FOLDERS_WITH_MANY_PARENTS
```
protected static final String STATEMENT_FOLDERS_WITH_MANY_PARENTS
```
  See Also:
  
  Constant Field Values
- STATEMENT_COUNT_OF_DIRECT_CHILDREN
```
protected static final String STATEMENT_COUNT_OF_DIRECT_CHILDREN
```
  See Also:
  
  Constant Field Values
- STATEMENT_GET_DIRECT_PARENTS
```
protected static final String STATEMENT_GET_DIRECT_PARENTS
```
  See Also:
  
  Constant Field Values
- MAP_LEVEL_MAIN
```
protected static final int MAP_LEVEL_MAIN
```
  See Also:
  
  Constant Field Values
- m_Service
```
protected S_LibraryService m_Service
```
  The parent library service
  
  (Unpublished)
- m_UpdateMode
```
protected int m_UpdateMode
```
  The update mode for this service
  
  (Unpublished)
- m_MaxLevel
```
protected int m_MaxLevel
```
  The maximum level.
  
  (Unpublished)
- m_CreationDeferred
```
protected boolean m_CreationDeferred
```
  Indicates whether or not the creation of the index has been deferred and has not yet completed.
  
  (Unpublished)
- m_UseExistsClause
```
protected boolean m_UseExistsClause
```
  Should FRQ's use an "exists" clause?
  
  (Unpublished)
- m_FolderIndexPropertyBundleId
```
protected Long m_FolderIndexPropertyBundleId
```
  The ID of the Folder Index Properties PropertyBundle
  
  (Unpublished)
- m_FolderIndexPropertyBundleClassId
```
protected Long m_FolderIndexPropertyBundleClassId
```
  The Class ID of the Folder Index Properties PropertyBundle
  
  (Unpublished)

Constructor Detail
- FolderIndexService
```
protected FolderIndexService(S_LibraryService service)
                      throws IfsException
```
  Construct a FolderIndexService.
  
  Parameters:
  
  service - the requesting library service
  
  Throws:
  
  IfsException - if operation fails.

Method Detail

init
```
protected void init()
             throws IfsException
```
Initialize this subservice.
This will throw if the supporting database table does not exist.

Throws:

IfsException - if the operation fails

(Unpublished)

dispose
```
public void dispose()
             throws IfsException
```
Terminate this subservice.
This method is required by the SubService interface; it currently does nothing.

Specified by:

dispose in interface SubService

Throws:

IfsException - if the operation fails

(Unpublished)

getMaxLevel
```
public int getMaxLevel(S_LibrarySession sess)
                throws IfsException
```
Gets the Max level setting for the Folder index.

Parameters:

sess - session context

Returns:

the maximum level

Throws:

IfsException - if the operation fails

(Unpublished)

registerNewFolder
```
protected void registerNewFolder(S_LibrarySession sess,
                                 long id)
                          throws IfsException
```
Register a new folder at the main level.

Parameters:

sess - session context

id - ID of the new Folder

Throws:

IfsException - if the operation fails

(Unpublished)

registerNewFolder
```
protected void registerNewFolder(S_LibrarySession sess,
                                 long id,
                                 int level)
                          throws IfsException
```
Register a new folder at the specified level.

Parameters:

sess - session context

id - ID of the new Folder

level - the index level to register the new folder

Throws:

IfsException - if the operation fails

(Unpublished)

registerNewFolderNow
```
protected void registerNewFolderNow(S_LibrarySession sess,
                                    long id,
                                    int level)
                             throws IfsException
```
Register a new folder at the specified level, without deferring.

Parameters:

sess - session context

id - ID of the new Folder

level - the index level to register the new folder

Throws:

IfsException - if the operation fails

(Unpublished)

unregisterFreedFolder
```
protected void unregisterFreedFolder(S_LibrarySession sess,
                                     long id)
                              throws IfsException
```
Unregister a folder that is being freed.

Parameters:

sess - session context

id - ID of the Folder

Throws:

IfsException - if the operation fails

(Unpublished)

unregisterFreedFolderNow
```
protected void unregisterFreedFolderNow(S_LibrarySession sess,
                                        long id)
                                 throws IfsException
```
Unregister a folder that is being freed, without deferring.

Parameters:

sess - session context

id - ID of the Folder

Throws:

IfsException - if the operation fails

(Unpublished)

addToFolder
```
protected void addToFolder(S_LibrarySession sess,
                           long parentid,
                           long childid)
                    throws IfsException
```
Update the index to reflect a child folder being added to a parent folder.

Parameters:

sess - session context

parentid - ID of the parent Folder

childid - ID of the child Folder

Throws:

IfsException - if the operation fails

(Unpublished)

addToFolderNow
```
protected void addToFolderNow(S_LibrarySession sess,
                              long parentid,
                              long childid)
                       throws IfsException
```
Update the index to reflect a child folder being added to a parent folder, without deferring.

Parameters:

sess - session context

parentid - ID of the parent Folder

childid - ID of the child Folder

Throws:

IfsException - if the operation fails

(Unpublished)

removeFromFolder
```
protected void removeFromFolder(S_LibrarySession sess,
                                long parentid,
                                long childid)
                         throws IfsException
```
Update the index to reflect a child folder being removed from a parent folder.

Parameters:

sess - session context

parentid - ID of the parent Folder

childid - ID of the child Folder

Throws:

IfsException - if the operation fails

(Unpublished)

removeFromFolderNow
```
protected void removeFromFolderNow(S_LibrarySession sess,
                                   long parentid,
                                   long childid)
                            throws IfsException
```
Update the index to reflect a child folder being removed from a parent folder, without deferring.

Parameters:

sess - session context

parentid - ID of the parent Folder

childid - ID of the child Folder

Throws:

IfsException - if the operation fails

(Unpublished)

getFoldersNeedingPromotion
```
protected Long[] getFoldersNeedingPromotion(S_LibrarySession sess,
                                            int level,
                                            int maxParentsThreshold,
                                            int maxChildrenThreshold)
                                     throws IfsException
```
Returns array of Long objects that hold the id of the folders at the current level that need promotion, in order to avoid explosion of rows in the odmz_folderindex because of multiply linked folders. (folder tree shaped as hour glass)

Parameters:

sess - handle to the session

level - current level

maxParentsThreshold - max parent's threshhold

maxChildrenThreshold - max child's threshhold

Returns:

array of folder Ids

Throws:

IfsException - if the operation fails

(Unpublished)

promoteFolder
```
protected void promoteFolder(S_LibrarySession sess,
                             long folderId,
                             int newLevel)
                      throws IfsException
```
Promote a folder to the specified level.

Parameters:

sess - session context

folderId - ID of the Folder to promote

newLevel - the level to promote the folder to

Throws:

IfsException - if the operation fails

(Unpublished)

promoteFolderNow
```
protected void promoteFolderNow(S_LibrarySession sess,
                                long folderId,
                                int newLevel)
                         throws IfsException
```
Promote a folder to the specified level, without deferring.

Parameters:

sess - session context

folderId - ID of the Folder to promote

newLevel - the level to promote the folder to

Throws:

IfsException - if the operation fails

(Unpublished)

getFrqClause
```
protected String getFrqClause(S_LibrarySession sess,
                              long topFolderId,
                              String poAlias,
                              String relView)
                       throws IfsException
```
Gets a Folder-restricted search clause (FRQ).
Uses the EXISTS or IN variants according to the setting in the FolderIndex PropertyBundle.

Parameters:

sess - session context

topFolderId - ID of the top Folder; all search results will be below this Folder

poAlias - the SQL alias used for the select target

relView - the name of the FolderRelationship view to be used

Returns:

the FRQ clause

Throws:

IfsException - if the operation fails

(Unpublished)

getFrqClause
```
protected String getFrqClause(S_LibrarySession sess,
                              long topFolderId,
                              String poAlias,
                              String relView,
                              Boolean useExists)
                       throws IfsException
```
Gets a Folder-restricted search clause (FRQ).
Uses the EXISTS or IN variants according to the setting in the FolderIndex PropertyBundle unless explicitly specified by the useExists argument.

Parameters:

sess - session context

topFolderId - ID of the top Folder; all search results will be below this Folder

poAlias - the SQL alias used for the select target

relView - the name of the FolderRelationship view to be used

useExists - indication as to which variant should be generated

Returns:

the FRQ clause

Throws:

IfsException - if the operation fails

(Unpublished)

getFrqExistsClause
```
protected String getFrqExistsClause(S_LibrarySession sess,
                                    long topFolderId,
                                    String poAlias,
                                    String relView)
                             throws IfsException
```
Gets a Folder-restricted search clause (FRQ) using the EXISTS syntax.

Parameters:

sess - session context

topFolderId - ID of the top Folder; all search results will be below this Folder

poAlias - the SQL alias used for the select target

relView - the name of the FolderRelationship view to be used

Returns:

the FRQ clause

Throws:

IfsException - if the operation fails

(Unpublished)

getFrqInClause
```
protected String getFrqInClause(S_LibrarySession sess,
                                long topFolderId,
                                String poAlias,
                                String relView)
                         throws IfsException
```
Gets a Folder-restricted search clause (FRQ) using the IN syntax.

Parameters:

sess - session context

topFolderId - ID of the top Folder; all search results will be below this Folder

poAlias - the SQL alias used for the select target

relView - the name of the FolderRelationship view to be used

Returns:

the FRQ clause

Throws:

IfsException - if the operation fails

(Unpublished)

isCreationDeferred

protected boolean isCreationDeferred(S_LibrarySession sess)
                              throws IfsException

Throws:: IfsException

initializeTables

protected void initializeTables(S_LibrarySession sess,
                                int maxLevels)
                         throws IfsException

Throws:: IfsException

createInitialSelfRows

protected void createInitialSelfRows(S_LibrarySession sess)
                              throws IfsException

Throws:: IfsException

createInitialDeferredEntries

protected void createInitialDeferredEntries(S_LibrarySession sess)
                                     throws IfsException

Throws:: IfsException

resetFolderIndex

protected int resetFolderIndex(S_LibrarySession sess)
                        throws IfsException

Throws:: IfsException

truncateTables

protected void truncateTables(S_LibrarySession sess)
                       throws IfsException

Throws:: IfsException

completeIndexCreation

protected void completeIndexCreation(S_LibrarySession sess,
                                     boolean creationDeferred)
                              throws IfsException

Throws:: IfsException

changeUpdateMode

protected void changeUpdateMode(S_LibrarySession sess,
                                int newMode)
                         throws IfsException

Throws:: IfsException

deferOperation

protected boolean deferOperation(S_LibrarySession sess)
                          throws IfsException

Throws:: IfsException

createDeferredUpdate

protected void createDeferredUpdate(S_LibrarySession sess,
                                    int operationType,
                                    long leftId,
                                    long rightId,
                                    int level)
                             throws IfsException

Throws:: IfsException

postEvent

protected void postEvent(S_LibrarySession sess)
                  throws IfsException

Throws:: IfsException

getFolderIndexPropertyBundleId

protected Long getFolderIndexPropertyBundleId(S_LibrarySession sess)
                                       throws IfsException

Throws:: IfsException

getFolderIndexPropertyBundleClassId

protected Long getFolderIndexPropertyBundleClassId(S_LibrarySession sess)
                                            throws IfsException

Throws:: IfsException

applyDeferredUpdate

protected void applyDeferredUpdate(S_LibrarySession sess,
                                   FolderIndexDeferredUpdate fidu)
                            throws IfsException

Throws:: IfsException

breakCycle

protected void breakCycle(S_LibrarySession sess,
                          long leftId,
                          long rightId)
                   throws IfsException

Throws:: IfsException

deleteDeferredUpdate

protected void deleteDeferredUpdate(S_LibrarySession sess,
                                    long id)
                             throws IfsException

Throws:: IfsException

selectDeferredUpdates

protected Vector selectDeferredUpdates(S_LibrarySession sess,
                                       int maxItems)
                                throws IfsException

Throws:: IfsException

setUpdateMode

protected void setUpdateMode(LibraryConnection lc,
                             Connection conn,
                             int updateMode)
                      throws IfsException

Throws:: IfsException

getFrqExistsClause

protected String getFrqExistsClause(long topFolderId,
                                    int topMapLevel,
                                    int bottomMapLevel,
                                    String poAlias,
                                    String relView)

getFrqInClause

protected String getFrqInClause(long topFolderId,
                                int topMapLevel,
                                int bottomMapLevel,
                                String relView)

isCycleCheckViolation

protected boolean isCycleCheckViolation(S_LibrarySession sess,
                                        LibraryConnection lc,
                                        Connection conn,
                                        long parentid,
                                        long childid,
                                        int parentMapLevel,
                                        int childMapLevel)
                                 throws IfsException

Throws:: IfsException

determineMapLevel

protected int determineMapLevel(LibraryConnection lc,
                                Connection conn,
                                int maxLevel,
                                long folderId)
                         throws IfsException

Throws:: IfsException

isFolderAtMaplevel

protected boolean isFolderAtMaplevel(LibraryConnection lc,
                                     Connection conn,
                                     long folderId,
                                     int maplevel)
                              throws IfsException

Throws:: IfsException

createMapSelfRow

protected void createMapSelfRow(S_LibrarySession sess,
                                LibraryConnection lc,
                                Connection conn,
                                long id,
                                long leftSource,
                                int maplevel)
                         throws IfsException

Throws:: IfsException

updateMapSelfRow

protected void updateMapSelfRow(S_LibrarySession sess,
                                LibraryConnection lc,
                                Connection conn,
                                long id,
                                long tempvalue,
                                int maplevel)
                         throws IfsException

Throws:: IfsException

deleteMapSelfRow

protected void deleteMapSelfRow(S_LibrarySession sess,
                                LibraryConnection lc,
                                Connection conn,
                                long id,
                                int maplevel)
                         throws IfsException

Throws:: IfsException

insertReferences

protected void insertReferences(S_LibrarySession sess,
                                LibraryConnection lc,
                                Connection conn,
                                long parentid,
                                long childid,
                                int maplevel)
                         throws IfsException

Throws:: IfsException

removeReferences

protected void removeReferences(S_LibrarySession sess,
                                LibraryConnection lc,
                                Connection conn,
                                long parentid,
                                long childid,
                                int maplevel)
                         throws IfsException

Throws:: IfsException

promoteFolder

protected void promoteFolder(S_LibrarySession sess,
                             LibraryConnection lc,
                             Connection conn,
                             int maxLevel,
                             long folderId,
                             int newLevel)
                      throws Exception

Throws:: Exception

promoteFolderOneLevel

protected void promoteFolderOneLevel(S_LibrarySession sess,
                                     LibraryConnection lc,
                                     Connection conn,
                                     HashMap promotedMap,
                                     long folderId,
                                     int currentLevel)
                              throws IfsException

Throws:: IfsException

promoteSingleFolderOneLevel

protected void promoteSingleFolderOneLevel(S_LibrarySession sess,
                                           LibraryConnection lc,
                                           Connection conn,
                                           long folderId,
                                           int currentLevel)
                                    throws IfsException

Throws:: IfsException

setMaxLevel

protected void setMaxLevel(LibraryConnection lc,
                           Connection conn,
                           int maxLevel)
                    throws IfsException

Throws:: IfsException

getFolderIndexLock

protected int getFolderIndexLock(LibraryConnection lc,
                                 Connection conn)
                          throws IfsException

Throws:: IfsException

getMaxLevel

protected int getMaxLevel(LibraryConnection lc,
                          Connection conn)
                   throws IfsException

Throws:: IfsException

getMaxLevel

protected int getMaxLevel(LibraryConnection lc,
                          Connection conn,
                          boolean shouldLock)
                   throws IfsException

Throws:: IfsException

verifyValidLevel

protected void verifyValidLevel(int level,
                                int maxLevel)
                         throws Exception

Throws:: Exception

isValidLevel

protected boolean isValidLevel(int level,
                               int maxLevel)

isIndexPartiallyCreated

protected boolean isIndexPartiallyCreated(LibraryConnection lc,
                                          Connection conn)
                                   throws Exception

Throws:: Exception

getUpdateMode

protected int getUpdateMode(LibraryConnection lc,
                            Connection conn)
                     throws IfsException

Throws:: IfsException

isCreationDeferred

protected boolean isCreationDeferred(LibraryConnection lc,
                                     Connection conn)
                              throws IfsException

Throws:: IfsException

insertMapParameterRow

protected void insertMapParameterRow(LibraryConnection lc,
                                     Connection conn,
                                     long key,
                                     long value)
                              throws IfsException

Throws:: IfsException

deleteMapParameterRow

protected void deleteMapParameterRow(LibraryConnection lc,
                                     Connection conn,
                                     long key)
                              throws IfsException

Throws:: IfsException

getMapParameterRow

protected int getMapParameterRow(LibraryConnection lc,
                                 Connection conn,
                                 int paramKey,
                                 boolean shouldLock)
                          throws IfsException

Throws:: IfsException

getPreparedStatement

protected PreparedStatement getPreparedStatement(LibraryConnection lc,
                                                 Connection conn,
                                                 String key)

constructPreparedStatement

protected PreparedStatement constructPreparedStatement(LibraryConnection lc,
                                                       Connection conn,
                                                       String key,
                                                       String stmt)
                                                throws SQLException

Throws:: SQLException

getFoldersWithParentCountAboveThreshold
```
protected Vector getFoldersWithParentCountAboveThreshold(S_LibrarySession sess,
                                                         int level,
                                                         int parentThreshhold)
                                                  throws IfsException
```
Returns Vector of folders whose direct parent count is greater than the max parent threshold.

Parameters:

sess - handle to the session

level - current level

parentThreshhold - parent count threshhold

Returns:

vector of folders that meet the criterion

Throws:

IfsException - if the operation fails

(Unpublished)

isChildCountAboveThreshold
```
protected boolean isChildCountAboveThreshold(S_LibrarySession sess,
                                             Long folderId,
                                             int childCountThreshold)
                                      throws IfsException
```
Returns true if the given folder has more children than the threshold.

Parameters:

sess - library session

folderId - id of the folder

childCountThreshold - child count threshhold

Returns:

true if folder has more direct children than the threshold

Throws:

IfsException - if the operation fails

(Unpublished)

getDirectParents
```
protected HashMap getDirectParents(S_LibrarySession sess,
                                   int level,
                                   Vector folderVector)
                            throws IfsException
```
Returns the direct parents of all the folders that are in the given vector.

Parameters:

sess - handle to library session

level - the current level

folderVector - vector of folders

Returns:

HashMap of parent folders.

Throws:

IfsException - if the operation fails

(Unpublished)

Class FolderIndexService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FPR_TABLE_NAME

REL_TABLE_NAME

MAP_TABLE_NAME

PARAM_TABLE_NAME

DEFERRED_UPDATE_TABLE_NAME

DEFERRED_UPDATE_SEQ_NAME

MAP_INDEX_LEFT

MAP_INDEX_RIGHT

FOLDER_TABLE_NAME

PARAMETER_KEY_MAXLEVEL

PARAMETER_KEY_PARTIALLY_CREATED

PARAMETER_KEY_MAP_UPDATE_MODE

PARAMETER_KEY_MAP_CREATION_DEFERRED

PARAMETER_VALUE_MAP_UPDATE_MODE_NONE

PARAMETER_VALUE_MAP_UPDATE_MODE_SYNC

PARAMETER_VALUE_MAP_UPDATE_MODE_ASYNC

STATEMENT_SELECT_ROWS_FOR_DELETE

STATEMENT_SELECT_PARAMETER

STATEMENT_SELECT_DEFERRED_UPDATE_ROWS

STATEMENT_INSERT_SELF_ROW

STATEMENT_INSERT_MAP_ROW

STATEMENT_INSERT_MAP_ROWS

STATEMENT_INSERT_DEFERRED_UPDATE_ROW

STATEMENT_UPDATE_SELF_ROW

STATEMENT_DELETE_SELF_ROW

STATEMENT_DELETE_MAP_ROW

STATEMENT_DELETE_ALL_BY_LEFT

STATEMENT_DELETE_DEFERRED_UPDATE_ROW

STATEMENT_PROMOTE_DESCENDANTS

STATEMENT_PROMOTE_ANCESTORS

STATEMENT_PROMOTE_ADD_DESCENDANTS

STATEMENT_CHECK_AT_LEVEL

STATEMENT_CYCLE_CHECK

STATEMENT_LOCK_PARAMETER

STATEMENT_SHOW_MAP

STATEMENT_FOLDERS_WITH_MANY_PARENTS

STATEMENT_COUNT_OF_DIRECT_CHILDREN

STATEMENT_GET_DIRECT_PARENTS

MAP_LEVEL_MAIN

m_Service

m_UpdateMode

m_MaxLevel

m_CreationDeferred

m_UseExistsClause

m_FolderIndexPropertyBundleId

m_FolderIndexPropertyBundleClassId

Constructor Detail

FolderIndexService

Method Detail

init

dispose

getMaxLevel

registerNewFolder

registerNewFolder

registerNewFolderNow

unregisterFreedFolder

unregisterFreedFolderNow

addToFolder

addToFolderNow

removeFromFolder

removeFromFolderNow

getFoldersNeedingPromotion

promoteFolder

promoteFolderNow

getFrqClause

getFrqClause

getFrqExistsClause

getFrqInClause

isCreationDeferred

initializeTables

createInitialSelfRows

createInitialDeferredEntries

resetFolderIndex

truncateTables