oracle.ifs.core.util

Class ManualTextIndexingRetainedEvent

java.lang.Object

oracle.ifs.common.RetainedEvent

oracle.ifs.core.util.ManualTextIndexingRetainedEvent

All Implemented Interfaces:

Serializable

public class ManualTextIndexingRetainedEvent
extends RetainedEvent
implements Serializable

A ManualTextIndexingRetainedEvent is a type of RetainedEvent used to notify an agent that a ContentObject requires manual text extraction for full text serach indexing.

Author:

Dave Long

See Also:

Serialized Form

(Published)

Field Summary

Fields

Modifier and Type	Field and Description
static int	COL_LENGTH Number of columns used to define this retained event
static int	CONTENTOBJECTID_COL_INDEX Column position (zero-based) for the ContentObject id
static String	IFS_FORMATPROPERTY_MANUALTEXTINDEXINGEXTRACTOR The Format property key used to identify the ManualTextIndexingExtractor class to use in generating the text stream.

Fields inherited from class oracle.ifs.common.RetainedEvent

m_Values

Constructor Summary

Constructors

Constructor and Description
ManualTextIndexingRetainedEvent() Construct an empty ManualTextIndexingRetainedEvent.
ManualTextIndexingRetainedEvent(AttributeValue coVal) Construct a ManualTextIndexingRetainedEvent that reflects a ContentObject requiring manual text extraction for indexing.
ManualTextIndexingRetainedEvent(ContentObject co) Construct a ManualTextIndexingRetainedEvent that reflects a ContentObject requiring manual text extraction for indexing.
ManualTextIndexingRetainedEvent(S_ContentObject sco) Construct a ManualTextIndexingRetainedEvent that reflects a ContentObject requiring manual text extraction for indexing.

Method Summary

Modifier and Type	Method and Description
RetainedEvent[]	constructArray(int size) Construct an array of the specified size.
RetainedEvent	constructInstance() Construct a new unpopulated instance, of the correct type.
ContentObject	getContentObject(LibrarySession session) Returns the ContentObject associated with this event.
protected RetainedEventDescriptor[]	getRetainedEventDescriptors() Get name/type descriptors that define the payload for this retained event.
String	getSequenceName() Get sequence name used by this specific type of retained event.
String	getTableName() Get table name used to store the specific type of retained event.
void	process(LibrarySession session) Process this retained event.

Methods inherited from class oracle.ifs.common.RetainedEvent

createDatabaseObjects, delete, dropDatabaseObjects, getCreateSequenceStatementSql, getCreateTableStatementSql, getDeleteStatementKey, getDeleteStatementSql, getDropSequenceStatementSql, getDropTableStatementSql, getId, getInsertStatementKey, getInsertStatementSql, getSelectStatementKey, getSelectStatementSql, getValues, insert, processAll, select, setValues, toString

Methods inherited from class java.lang.Object

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

Field Detail

IFS_FORMATPROPERTY_MANUALTEXTINDEXINGEXTRACTOR

public static final String IFS_FORMATPROPERTY_MANUALTEXTINDEXINGEXTRACTOR

The Format property key used to identify the ManualTextIndexingExtractor class to use in generating the text stream.

See Also:

Constant Field Values

COL_LENGTH

public static final int COL_LENGTH

Number of columns used to define this retained event

See Also:

Constant Field Values

CONTENTOBJECTID_COL_INDEX

public static final int CONTENTOBJECTID_COL_INDEX

Column position (zero-based) for the ContentObject id

See Also:

Constant Field Values

Constructor Detail

ManualTextIndexingRetainedEvent

public ManualTextIndexingRetainedEvent()

Construct an empty ManualTextIndexingRetainedEvent.

This variant is used when an instance is needed to select other instances of ManualTextIndexingRetainedEvent from the database.

ManualTextIndexingRetainedEvent

public ManualTextIndexingRetainedEvent(ContentObject co)
                                throws IfsException

Construct a ManualTextIndexingRetainedEvent that reflects a ContentObject requiring manual text extraction for indexing.

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

ManualTextIndexingRetainedEvent

public ManualTextIndexingRetainedEvent(S_ContentObject sco)
                                throws IfsException

Construct a ManualTextIndexingRetainedEvent that reflects a ContentObject requiring manual text extraction for indexing.

Parameters:

sco - the S_ContentObject

Throws:

IfsException - if the operation fails

ManualTextIndexingRetainedEvent

public ManualTextIndexingRetainedEvent(AttributeValue coVal)
                                throws IfsException

Construct a ManualTextIndexingRetainedEvent that reflects a ContentObject requiring manual text extraction for indexing.

Parameters:

coVal - the ContentObject value

Throws:

IfsException - if the operation fails

Method Detail

getTableName

public final String getTableName()

Get table name used to store the specific type of retained event.

Specified by:

getTableName in class RetainedEvent

Returns:

the table name

(Published)

getSequenceName

public String getSequenceName()

Get sequence name used by this specific type of retained event.

Specified by:

getSequenceName in class RetainedEvent

Returns:

the sequence name

(Published)

getRetainedEventDescriptors

protected RetainedEventDescriptor[] getRetainedEventDescriptors()

Get name/type descriptors that define the payload for this retained event.

Specified by:

getRetainedEventDescriptors in class RetainedEvent

Returns:

the name/type descriptors

(Published)

constructInstance

public RetainedEvent constructInstance()

Construct a new unpopulated instance, of the correct type.

Specified by:

constructInstance in class RetainedEvent

Returns:

the new instance

(Published)

constructArray

public RetainedEvent[] constructArray(int size)

Construct an array of the specified size.

Specified by:

constructArray in class RetainedEvent

Parameters:

size - the array size

Returns:

the new array

(Published)

getContentObject

public ContentObject getContentObject(LibrarySession session)
                               throws IfsException

Returns the ContentObject associated with this event.

Parameters:

session - the session context

Returns:

the ContentObject

Throws:

IfsException - if the operation fails

process

public void process(LibrarySession session)
             throws IfsException

Process this retained event.

It is assumed that a transaction process has been established by the caller. Also, the caller will ensure that the event is properly disposed aftert this method completes.

Overrides:

process in class RetainedEvent

Parameters:

session - session context

Throws:

IfsException - if the operation fails