oracle.ifs.server

Class OracleContentStorageManager

java.lang.Object

oracle.ifs.server.S_LibrarySessionContentStorageManager

oracle.ifs.server.OracleContentStorageManager

All Implemented Interfaces:

ContentStorageManager

public class OracleContentStorageManager
extends S_LibrarySessionContentStorageManager

OracleContentStorageManager extends S_LibrarySessionContentStorageManager to implement Oracle-specific behavior for the ContentStorageManager, used to manage content storage.

A ContentStorageManager ("CSM") is created for and bound to each S_LibrarySession. CSM mediates access to the subsystem that stores, retrieves, and otherwise manages binary content. This subsystem includes:

• MEDIA and its subtypes
• the content storage tables
• content migration between MEDIAs
• read indication
• quota
• Oracle Text indexing
• Oracle Text themes, gists, and summaries

(Published)

Field Summary

Fields inherited from class oracle.ifs.server.S_LibrarySessionContentStorageManager

CONTEXTROUTERTABLE_TABLENAME, INDEXINGSTATE_AWAITING_EXTRACTION

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OracleContentStorageManager(S_LibrarySession session) Constructs a CSM for Oracle.

Method Summary

Modifier and Type	Method and Description
int	deleteOldFilteredContent(S_LibrarySession session, long age) Delete old filtered content entries.
void	destroyTextRenditions(S_ContentObject co) Destroy all text renditions: themes, summaries, and filtered content.
void	dispose() Disposes this CSM.
protected void	extractContentForIndexing(S_ContentObject co) For the specified ContentObject, extracts the content and loads it into the INDEXABLECONTENT column in the corresponding ODMZ_CONTEXT_ROUTER row.
void	filterContent(S_ContentObject co, boolean plaintext) Generate filtered content for the specified ContentObject.
void	generateSummary(S_ContentObject co, String pointOfView, long sizeAsPercent, long sizeAsNumParagraphs, String summaryLevel) Generate Summary for specified ContentObject.
void	generateThemes(S_ContentObject co, boolean fullThemes) Generate Themes for specified ContentObject.
static ContextTable[]	getContextTables(S_LibrarySession sess) Called by search.
Reader	getFilteredContent(S_ContentObject co) Gets the filtered content for specified ContentObject.
String	getFullTextIndexName() Gets the name of the full text index.
static String	getIndexName()
Reader	getSummary(S_ContentObject co, String pointOfView) Gets the summary for specified ContentObject and point of view.
ContextTheme[]	getThemes(S_ContentObject co) Gets the generate Themes for specified ContentObject.
void	insertIntoContextRouter(Long coId, Long coClassId, Long cid, S_Media media, S_ContentVaultEntry cve, long contentSize, String ianaCharacterSet, String oracleLanguage, boolean text, boolean indirectFullTextIndexing) Inserts a row in the context router table.
void	invalidateFilteredContent(S_ContentObject co) Invalidates any Filtered Content that was generated for specified ContentObject.
void	invalidateSummaries(S_ContentObject co) Invalidates any Summary that was generated for specified ContentObject.
void	invalidateThemes(S_ContentObject co) Invalidates any Themes that have been generated for specified ContentObject.
boolean	isFullTextIndexingEnabled() Gets whether full-text indexing is enabled.
void	manuallyInsertIntoContextRouter(S_ContentObject co, Reader reader) Insert of a row in the context router table for the case of manual text indexing.
void	registerBfile(Object bfileObj) Binds the specified BFILE to this session.
void	syncIndex() Sync's the index.
void	unregisterBfile(Object bfileObj) Unbinds the specified BFILE from this session.

Methods inherited from class oracle.ifs.server.S_LibrarySessionContentStorageManager

acquireByteBuffer, deleteFromContextRouter, destroyContent, extractContentForIndexing, getByteBufferSize, getContentByRandomAccess, getContentReader, getContentStream, getLastAccessDate, getNewContentID, getOracleCharacterSet, getSession, registerRandomAccessor, releaseByteBuffer, resolveCharacterSet, retrieveSerializedObject, selectMedia, setContentProperties, storeSerializedObject, unregisterRandomAccessor, updateContentByRandomAccess, updateLastAccessDate, validateMedia, validateMediaAndSetContent, verifyCanDestroyContent

Methods inherited from class java.lang.Object

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

Constructor Detail

OracleContentStorageManager

protected OracleContentStorageManager(S_LibrarySession session)
                               throws IfsException

Constructs a CSM for Oracle.

Parameters:

session - the sesion to which this CSM belongs; required

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

dispose

public void dispose()

Disposes this CSM.

Specified by:

dispose in interface ContentStorageManager

Overrides:

dispose in class S_LibrarySessionContentStorageManager

(Unpublished)

registerBfile

public void registerBfile(Object bfileObj)
                   throws IfsException

Binds the specified BFILE to this session.

Specified by:

registerBfile in interface ContentStorageManager

Specified by:

registerBfile in class S_LibrarySessionContentStorageManager

Parameters:

bfileObj - the BFILE

Throws:

IfsException - if the operation fails

(Unpublished)

unregisterBfile

public void unregisterBfile(Object bfileObj)
                     throws IfsException

Unbinds the specified BFILE from this session.

Specified by:

unregisterBfile in interface ContentStorageManager

Specified by:

unregisterBfile in class S_LibrarySessionContentStorageManager

Parameters:

bfileObj - the BFILE

Throws:

IfsException - if the operation fails

(Unpublished)

isFullTextIndexingEnabled

public boolean isFullTextIndexingEnabled()
                                  throws IfsException

Gets whether full-text indexing is enabled.

Each invocation of this method queries the database. S_LibrarySession.isFullTextIndexingEnabled() caches the value returned by this method, and should almost always be used instead of this method.

Specified by:

isFullTextIndexingEnabled in interface ContentStorageManager

Specified by:

isFullTextIndexingEnabled in class S_LibrarySessionContentStorageManager

Returns:

whether full-text indexing is enabled

Throws:

IfsException - if the operation fails

(Unpublished)

getFullTextIndexName

public String getFullTextIndexName()

Gets the name of the full text index.

Specified by:

getFullTextIndexName in interface ContentStorageManager

Specified by:

getFullTextIndexName in class S_LibrarySessionContentStorageManager

Returns:

the name of the full text index

(Published)

getIndexName

public static String getIndexName()

(Unpublished)

getContextTables

public static ContextTable[] getContextTables(S_LibrarySession sess)
                                       throws IfsException

Called by search.

Throws:

IfsException

(Unpublished)

insertIntoContextRouter

public void insertIntoContextRouter(Long coId,
                                    Long coClassId,
                                    Long cid,
                                    S_Media media,
                                    S_ContentVaultEntry cve,
                                    long contentSize,
                                    String ianaCharacterSet,
                                    String oracleLanguage,
                                    boolean text,
                                    boolean indirectFullTextIndexing)
                             throws IfsException

Inserts a row in the context router table.

Specified by:

insertIntoContextRouter in interface ContentStorageManager

Specified by:

insertIntoContextRouter in class S_LibrarySessionContentStorageManager

Parameters:

coId - the ContentObject id; required

coClassId - the ContentObject class id; required

cid - the content id; required

media - the Media where the content is stored; required

cve - the ContentVaultEntry (can be null)

contentSize - the content size; required

ianaCharacterSet - the Iana character set code

oracleLanguage - the Oracle language code

text - whether the context is a text format

indirectFullTextIndexing - whether to perform indirect full-text indexing

Throws:

IfsException - if the operation fails

(Published)

manuallyInsertIntoContextRouter

public void manuallyInsertIntoContextRouter(S_ContentObject co,
                                            Reader reader)
                                     throws IfsException

Insert of a row in the context router table for the case of manual text indexing.

Postgres uses a different Full text search insert mode known as "manual text indexing". This is driven by an agent. Oracle does not currently support this mode.

Parameters:

co - the ContentObject; required

reader - the manually obtained text reader to be indexed

Throws:

IfsException - if the operation fails

(Published)

syncIndex

public void syncIndex()
               throws IfsException

Sync's the index. Note, this affects all context media.

Specified by:

syncIndex in interface ContentStorageManager

Specified by:

syncIndex in class S_LibrarySessionContentStorageManager

Throws:

IfsException - if the operation fails

(Unpublished)

extractContentForIndexing

protected void extractContentForIndexing(S_ContentObject co)
                                  throws IfsException

For the specified ContentObject, extracts the content and loads it into the INDEXABLECONTENT column in the corresponding ODMZ_CONTEXT_ROUTER row.

Specified by:

extractContentForIndexing in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

generateThemes

public void generateThemes(S_ContentObject co,
                           boolean fullThemes)
                    throws IfsException

Generate Themes for specified ContentObject.

Specified by:

generateThemes in interface ContentStorageManager

Specified by:

generateThemes in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

fullThemes - whether full themes are desired

Throws:

IfsException - if the operation fails

getThemes

public ContextTheme[] getThemes(S_ContentObject co)
                         throws IfsException

Gets the generate Themes for specified ContentObject.

Specified by:

getThemes in interface ContentStorageManager

Specified by:

getThemes in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

Returns:

the themes

Throws:

IfsException - if the operation fails

invalidateThemes

public void invalidateThemes(S_ContentObject co)
                      throws IfsException

Invalidates any Themes that have been generated for specified ContentObject.

Specified by:

invalidateThemes in interface ContentStorageManager

Specified by:

invalidateThemes in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

generateSummary

public void generateSummary(S_ContentObject co,
                            String pointOfView,
                            long sizeAsPercent,
                            long sizeAsNumParagraphs,
                            String summaryLevel)
                     throws IfsException

Generate Summary for specified ContentObject.

Specified by:

generateSummary in interface ContentStorageManager

Specified by:

generateSummary in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

pointOfView - the point Of view

sizeAsPercent - the size As Percent

sizeAsNumParagraphs - the size As number of paragraphs

summaryLevel - the summary level

Throws:

IfsException - if the operation fails

getSummary

public Reader getSummary(S_ContentObject co,
                         String pointOfView)
                  throws IfsException

Gets the summary for specified ContentObject and point of view.

Specified by:

getSummary in interface ContentStorageManager

Specified by:

getSummary in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

pointOfView - the point Of view

Returns:

the summary

Throws:

IfsException - if the operation fails

invalidateSummaries

public void invalidateSummaries(S_ContentObject co)
                         throws IfsException

Invalidates any Summary that was generated for specified ContentObject.

Specified by:

invalidateSummaries in interface ContentStorageManager

Specified by:

invalidateSummaries in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

filterContent

public void filterContent(S_ContentObject co,
                          boolean plaintext)
                   throws IfsException

Generate filtered content for the specified ContentObject.

Specified by:

filterContent in interface ContentStorageManager

Specified by:

filterContent in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

plaintext - whether to use plain text

Throws:

IfsException - if the operation fails

getFilteredContent

public Reader getFilteredContent(S_ContentObject co)
                          throws IfsException

Gets the filtered content for specified ContentObject.

Specified by:

getFilteredContent in interface ContentStorageManager

Specified by:

getFilteredContent in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

Returns:

the filtered content

Throws:

IfsException - if the operation fails

invalidateFilteredContent

public void invalidateFilteredContent(S_ContentObject co)
                               throws IfsException

Invalidates any Filtered Content that was generated for specified ContentObject.

Specified by:

invalidateFilteredContent in interface ContentStorageManager

Specified by:

invalidateFilteredContent in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

destroyTextRenditions

public void destroyTextRenditions(S_ContentObject co)
                           throws IfsException

Destroy all text renditions: themes, summaries, and filtered content.

Specified by:

destroyTextRenditions in interface ContentStorageManager

Specified by:

destroyTextRenditions in class S_LibrarySessionContentStorageManager

Parameters:

co - the ContentObject

Throws:

IfsException - if the operation fails

deleteOldFilteredContent

public int deleteOldFilteredContent(S_LibrarySession session,
                                    long age)
                             throws IfsException

Delete old filtered content entries.

Specified by:

deleteOldFilteredContent in interface ContentStorageManager

Specified by:

deleteOldFilteredContent in class S_LibrarySessionContentStorageManager

Parameters:

session - the S_LibrarySession

age - the number of seconds that constitutes an "old" entry

Throws:

IfsException - if the operation fails