oracle.ifs.core.beans

Class FolderIndexPartitionSpecification

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SystemObject

oracle.ifs.beans.TieSystemObject

oracle.ifs.core.beans.FolderIndexPartitionSpecification

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SystemObjectInterface, Traceable

Direct Known Subclasses:

TieFolderIndexPartitionSpecification

public class FolderIndexPartitionSpecification
extends TieSystemObject

A FolderIndexPartitionSpecification specifies information used by a dispatching handler to dispatch AuditEvents to working handlers.

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DESCRIPTION_ATTRIBUTE The name of the attribute that holds the description of the FolderIndexPartitionSpecification.
static String	INDEXNAME_PREFIX_LEFTRIGHT The prefix for the database index name used for the LEFT/RIGHT index.
static String	INDEXNAME_PREFIX_LEFTSOURCE The prefix for the database index name used for the LEFTSOURCE index.
static String	INDEXNAME_PREFIX_RIGHTLEFT The prefix for the database index name used for the RIGHT/LEFT index.
static String	NAME_ATTRIBUTE The name of the attribute that holds the name of the FolderIndexPartitionSpecification.
static String	SETTINGS_ATTRIBUTE The name of the Attribute that holds the miscellaneous settings for partition management.
static String	SYNCHRONOUS_ATTRIBUTE The name of the attribute that holds the indication of whether the partition is managed synchronously.
static String	TABLENAME_PREFIX The prefix for the table name.
static String	TABLENAMESUFFIX_ATTRIBUTE The name of the attribute that holds the suffix for the table and other database objects for the storage of this partition.
static String	TOPFOLDER_ATTRIBUTE The name of the attribute that holds the top folder for the partition (PublicObject).

Fields inherited from class oracle.ifs.beans.SystemObject

ACTIVE_ATTRIBUTE, POLICYBUNDLE_ATTRIBUTE, POLICYLISTS_ATTRIBUTE, PROPERTYBUNDLE_ATTRIBUTE

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FolderIndexPartitionSpecification(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Constructs a FolderIndexPartitionSpecification object.

Method Summary

Modifier and Type	Method and Description
protected void	activatePartition() Activate the partition.
void	addSetting(String key, AttributeValue value) Adds a setting (SimpleProperty) for this object.
void	completeDeactivatePartition() Complete to deactivation of the partition.
static FolderIndexPartitionSpecification[]	findAll(LibrarySession session) Returns the set of defined FolderIndexPartitionSpecifications.
static FolderIndexPartitionSpecification[]	findAllActive(LibrarySession session) Returns the set of ACTIVE FolderIndexPartitionSpecifications.
static FolderIndexPartitionSpecification	findByName(LibrarySession session, String name) Returns the a FolderIndexPartitionSpecification matching the specified name.
String	getDescription() Gets the description of this FolderIndexPartitionSpecification.
String	getLeftRightIndexName() Returns name of the database index used for "Left, Right"
String	getLeftsourceIndexName() Returns name of the database index used for "Leftsource"
static LibraryObjectLookupCache	getLibraryObjectLookupCache(LibrarySession session) Returns the LibraryObjectLookupCache used by find FolderIndexPartitionSpecification instances by name.
String	getRightLeftIndexName() Returns name of the database index used for "Right, Left"
AttributeValue	getSetting(String key) Gets the setting on this object for the specified key.
SimpleProperty[]	getSettings() Gets the settings used to describe the instance.
String	getTableName() Returns name of the table used for the storage of this partition.
String	getTableNameSuffix() Returns suffix for the table and other database objects for the storage of this partition.
Folder	getTopFolder() Returns the top folder for the partition.
Long	getTopFolderId() Returns the top folder ID for the partition.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
int	identifyAllRowCount() Get the number of rows in the partition.
List<AttributeValueTable>	identifyAllRows() Identifies all rows in the partition.
int	identifyDuplicateRowCount() Get the number of duplicate rows in the partition.
List<AttributeValueTable>	identifyDuplicateRows() Identifies any duplicate rows in the partition.
List<AttributeValueTable>	identifyExtraRows() Identifies any extra rows in the partition - rows that should not be present based on the state of the master folderindex.
List<AttributeValueTable>	identifyMissingRows() Identifies any missing rows in the partition - rows that should be present based on the state of the master folderindex.
boolean	isDeactivateCompleted() Gets whether this instance has been completely deactivated.
boolean	isDeactivateRequested() Gets whether this instance has been requested to deactivate.
boolean	isPreviouslyActivated() Gets whether this instance was at one time activated.
boolean	isSynchronous() Gets indication of whether the partition is managed synchronously.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a SystemObject.
protected void	postUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the update of a SystemObject.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
void	rebuildPartition() Rebuild the partition.
int	removeDuplicateRows() Removes any duplicate rows in the partition.
void	removeSetting(String key) Removes a setting (SimpleProperty) for this object.
protected void	requestDeactivatePartition() Request to deactivate the partition.
List<AttributeValueTable>	selectWithMinus(LibrarySession sess, String sql1, String sql2, String sort) Perform the two specified subselects with a MINUS (or EXCEPT for Postgres), operator identifying rows that are present in the first SQL but not in the second SQL.
void	setDeactivateCompleted(boolean val) Sets whether this instance has been completely deactivated.
void	setDeactivateRequested(boolean val) Sets whether this instance has been requested to deactivate.
void	setPreviouslyActivated(boolean val) Sets whether this instance was at one time activated.

Methods inherited from class oracle.ifs.beans.SystemObject

addCategory, constructSystemObject, constructSystemObjectVector, free, freeCategories, getCategories, getCategories, getCategories, getCategories, getPolicyBundle, getPolicyLists, handleCreate, hasPropertyBundleAttribute, isActive, preCreate, preUpdate, putPolicy, removeAllPolicies, removePolicy, removePolicy, setActive, setPolicyBundle, setPolicyLists

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, createInstance, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, isValidEventType, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

(Published)

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the attribute that holds the name of the FolderIndexPartitionSpecification. (String[700])

See Also:

Constant Field Values

DESCRIPTION_ATTRIBUTE

public static final String DESCRIPTION_ATTRIBUTE

The name of the attribute that holds the description of the FolderIndexPartitionSpecification. (String[2000])

See Also:

Constant Field Values

TOPFOLDER_ATTRIBUTE

public static final String TOPFOLDER_ATTRIBUTE

The name of the attribute that holds the top folder for the partition (PublicObject).

See Also:

Constant Field Values

TABLENAMESUFFIX_ATTRIBUTE

public static final String TABLENAMESUFFIX_ATTRIBUTE

The name of the attribute that holds the suffix for the table and other database objects for the storage of this partition. (String[22])

See Also:

Constant Field Values

SYNCHRONOUS_ATTRIBUTE

public static final String SYNCHRONOUS_ATTRIBUTE

The name of the attribute that holds the indication of whether the partition is managed synchronously. (Boolean)

See Also:

Constant Field Values

SETTINGS_ATTRIBUTE

public static final String SETTINGS_ATTRIBUTE

The name of the Attribute that holds the miscellaneous settings for partition management. (SimpleProperty[])

See Also:

Constant Field Values

TABLENAME_PREFIX

public static final String TABLENAME_PREFIX

The prefix for the table name.

See Also:

Constant Field Values

INDEXNAME_PREFIX_LEFTRIGHT

public static final String INDEXNAME_PREFIX_LEFTRIGHT

The prefix for the database index name used for the LEFT/RIGHT index.

See Also:

Constant Field Values

INDEXNAME_PREFIX_RIGHTLEFT

public static final String INDEXNAME_PREFIX_RIGHTLEFT

The prefix for the database index name used for the RIGHT/LEFT index.

See Also:

Constant Field Values

INDEXNAME_PREFIX_LEFTSOURCE

public static final String INDEXNAME_PREFIX_LEFTSOURCE

The prefix for the database index name used for the LEFTSOURCE index.

See Also:

Constant Field Values

Constructor Detail

FolderIndexPartitionSpecification

protected FolderIndexPartitionSpecification(LibrarySession session,
                                            Long id,
                                            Long classId,
                                            S_LibraryObjectData data)
                                     throws IfsException

Constructs a FolderIndexPartitionSpecification object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Description copied from class: LibraryObject

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getDescription

public String getDescription()
                      throws IfsException

Gets the description of this FolderIndexPartitionSpecification.

Returns:

the object description

Throws:

IfsException - if operation fails

getTopFolderId

public Long getTopFolderId()
                    throws IfsException

Returns the top folder ID for the partition.

Returns:

the top folder ID for the partition

Throws:

IfsException - if the operation fails.

getTopFolder

public Folder getTopFolder()
                    throws IfsException

Returns the top folder for the partition.

Returns:

the top folder for the partition

Throws:

IfsException - if the operation fails.

getTableNameSuffix

public String getTableNameSuffix()
                          throws IfsException

Returns suffix for the table and other database objects for the storage of this partition.

Returns:

the table name suffix

Throws:

IfsException - if the operation fails.

isSynchronous

public boolean isSynchronous()
                      throws IfsException

Gets indication of whether the partition is managed synchronously.

Returns:

true iff the partition is managed synchronously

Throws:

IfsException - if the operation fails

getSettings

public SimpleProperty[] getSettings()
                             throws IfsException

Gets the settings used to describe the instance.

Returns:

the settings

Throws:

IfsException - if the operation fails

getSetting

public AttributeValue getSetting(String key)
                          throws IfsException

Gets the setting on this object for the specified key.

Parameters:

key - the key

Returns:

the setting's value

Throws:

IfsException - if the operation fails

getTableName

public String getTableName()
                    throws IfsException

Returns name of the table used for the storage of this partition.

Returns:

the table name

Throws:

IfsException - if the operation fails.

getLeftRightIndexName

public String getLeftRightIndexName()
                             throws IfsException

Returns name of the database index used for "Left, Right"

Returns:

the index name

Throws:

IfsException - if the operation fails.

getRightLeftIndexName

public String getRightLeftIndexName()
                             throws IfsException

Returns name of the database index used for "Right, Left"

Returns:

the index name

Throws:

IfsException - if the operation fails.

getLeftsourceIndexName

public String getLeftsourceIndexName()
                              throws IfsException

Returns name of the database index used for "Leftsource"

Returns:

the index name

Throws:

IfsException - if the operation fails.

addSetting

public void addSetting(String key,
                       AttributeValue value)
                throws IfsException

Adds a setting (SimpleProperty) for this object.

Parameters:

key - the setting property's key

value - the setting property's value

Throws:

IfsException - if the operation fails

removeSetting

public void removeSetting(String key)
                   throws IfsException

Removes a setting (SimpleProperty) for this object.

Parameters:

key - the setting property's key

Throws:

IfsException - if the operation fails

getLibraryObjectLookupCache

public static LibraryObjectLookupCache getLibraryObjectLookupCache(LibrarySession session)
                                                            throws IfsException

Returns the LibraryObjectLookupCache used by find FolderIndexPartitionSpecification instances by name.

Parameters:

session - the session context

Returns:

the LibraryObjectLookupCache

Throws:

IfsException - if the operation fails.

findAll

public static FolderIndexPartitionSpecification[] findAll(LibrarySession session)
                                                   throws IfsException

Returns the set of defined FolderIndexPartitionSpecifications.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of FolderIndexPartitionSpecifications; returns null if there are none

Throws:

IfsException - if the operation fails.

findByName

public static FolderIndexPartitionSpecification findByName(LibrarySession session,
                                                           String name)
                                                    throws IfsException

Returns the a FolderIndexPartitionSpecification matching the specified name.

FolderIndexPartitionSpecification names are case sensitive, so this operations requires an exact match with respect to case.

Parameters:

session - the session context

name - the FolderIndexPartitionSpecification name

Returns:

the FolderIndexPartitionSpecification matching the specified name; or null if there exists no matching FolderIndexPartitionSpecification

Throws:

IfsException - if the operation fails.

findAllActive

public static FolderIndexPartitionSpecification[] findAllActive(LibrarySession session)
                                                         throws IfsException

Returns the set of ACTIVE FolderIndexPartitionSpecifications.

The instances will be sorted by name.

Parameters:

session - the session context

Returns:

the set of FolderIndexPartitionSpecifications

Throws:

IfsException - if the operation fails.

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: SystemObject

Extensibility point to perform actions after the creation of a SystemObject.

This assumes that a transaction context has already been established.

Overrides:

postCreate in class SystemObject

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if operation fails

postUpdate

protected void postUpdate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: SystemObject

Extensibility point to perform actions after the update of a SystemObject.

Create any categories that are specified in the definition.

Overrides:

postUpdate in class SystemObject

Parameters:

lodef - object definition used to define how the target object was updated

Throws:

IfsException - if operation fails

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.

rebuildPartition

public void rebuildPartition()
                      throws IfsException

Rebuild the partition.

This will drop the underlying table and re-create it - leaving everything else about the obejct the same.

This can only only only be run with all Nodes down at the moment. There is no easy way for me to verify this, so be careful out there.

Throws:

IfsException - if the operation fails.

activatePartition

protected void activatePartition()
                          throws IfsException

Activate the partition.

Throws:

IfsException - if the operation fails.

requestDeactivatePartition

protected void requestDeactivatePartition()
                                   throws IfsException

Request to deactivate the partition.

Throws:

IfsException - if the operation fails.

completeDeactivatePartition

public void completeDeactivatePartition()
                                 throws IfsException

Complete to deactivation of the partition.

Throws:

IfsException - if the operation fails.

isPreviouslyActivated

public boolean isPreviouslyActivated()
                              throws IfsException

Gets whether this instance was at one time activated.

Returns:

true iff this instance was at one time activated

Throws:

IfsException - if the operation fails.

isDeactivateRequested

public boolean isDeactivateRequested()
                              throws IfsException

Gets whether this instance has been requested to deactivate.

Returns:

true iff this instance was requested to deactivate

Throws:

IfsException - if the operation fails.

isDeactivateCompleted

public boolean isDeactivateCompleted()
                              throws IfsException

Gets whether this instance has been completely deactivated.

Returns:

true iff this instance has been completely deactivated

Throws:

IfsException - if the operation fails.

setPreviouslyActivated

public void setPreviouslyActivated(boolean val)
                            throws IfsException

Sets whether this instance was at one time activated.

Parameters:

val - true iff this instance was at one time activated

Throws:

IfsException - if the operation fails.

setDeactivateRequested

public void setDeactivateRequested(boolean val)
                            throws IfsException

Sets whether this instance has been requested to deactivate.

Parameters:

val - true iff this instance was requested to deactivate

Throws:

IfsException - if the operation fails.

setDeactivateCompleted

public void setDeactivateCompleted(boolean val)
                            throws IfsException

Sets whether this instance has been completely deactivated.

Parameters:

val - true iff this instance has been completely deactivated

Throws:

IfsException - if the operation fails.

identifyMissingRows

public List<AttributeValueTable> identifyMissingRows()
                                              throws IfsException

Identifies any missing rows in the partition - rows that should be present based on the state of the master folderindex.

Returns:

the missing rows

Throws:

IfsException - if the operation fails.

identifyExtraRows

public List<AttributeValueTable> identifyExtraRows()
                                            throws IfsException

Identifies any extra rows in the partition - rows that should not be present based on the state of the master folderindex.

Returns:

the missing rows

Throws:

IfsException - if the operation fails.

identifyDuplicateRows

public List<AttributeValueTable> identifyDuplicateRows()
                                                throws IfsException

Identifies any duplicate rows in the partition.

Returns:

the duplicate rows

Throws:

IfsException - if the operation fails.

identifyDuplicateRowCount

public int identifyDuplicateRowCount()
                              throws IfsException

Get the number of duplicate rows in the partition.

Returns:

the number of duplicate rows in the partition

Throws:

IfsException - if the operation fails.

identifyAllRows

public List<AttributeValueTable> identifyAllRows()
                                          throws IfsException

Identifies all rows in the partition.

Returns:

the duplicate rows

Throws:

IfsException - if the operation fails.

identifyAllRowCount

public int identifyAllRowCount()
                        throws IfsException

Get the number of rows in the partition.

Returns:

the number of rows in the partition

Throws:

IfsException - if the operation fails.

selectWithMinus

public List<AttributeValueTable> selectWithMinus(LibrarySession sess,
                                                 String sql1,
                                                 String sql2,
                                                 String sort)
                                          throws IfsException

Perform the two specified subselects with a MINUS (or EXCEPT for Postgres), operator identifying rows that are present in the first SQL but not in the second SQL.

Parameters:

sess - the session context

sql1 - the first SQL

sql2 - the second SQL

sort - the ORDER BY clause

Returns:

the missing rows from the second SQL

Throws:

IfsException - if the operation fails.

removeDuplicateRows

public int removeDuplicateRows()
                        throws IfsException

Removes any duplicate rows in the partition.

Returns:

the number of duplicate rows deleted

Throws:

IfsException - if the operation fails.