gate.persist
Class OracleDataStore

java.lang.Object
  gate.util.AbstractFeatureBearer
      gate.persist.JDBCDataStore
          gate.persist.OracleDataStore

All Implemented Interfaces:

DataStore, CreoleListener, DatabaseDataStore, FeatureBearer, NameBearer, Serializable, EventListener

public class OracleDataStore
extends JDBCDataStore

See Also:

Serialized Form

Field Summary

Fields inherited from class gate.persist.JDBCDataStore

ac, datastoreComment, dbSchema, dbType, dependentResources, iconName, jdbcConn, name, session

Fields inherited from class gate.util.AbstractFeatureBearer

features

Fields inherited from interface gate.DataStore

DATASTORE_FEATURE_NAME, LR_ID_FEATURE_NAME

Constructor Summary

OracleDataStore()
default constructor - just call the super constructor (may change in the future)

Method Summary

protected void	_syncDocumentContent(Document doc) helper for sync() - never call directly
protected void	_syncDocumentHeader(Document doc) helper for sync() - never call directly
protected void	_syncFeatures(LanguageResource lr) helper for sync() - never call directly
protected void	_syncLR(LanguageResource lr) helper for sync() NEVER call directly
protected void	_syncRemovedDocumentsFromCorpus(List docLRIDs, Long corpLRID) helper for sync() - never call directly
protected void	addDocumentToCorpus(Long docID, Long corpID) adds document to corpus in the database if the document is already part of the corpus nothing changes
protected boolean	canAccessLR(Long lrID, int mode) Checks if the user (identified by the sessionID) has some access (read/write) to the LR
void	close() Close the data store.
void	create() Create a new data store.
protected void	createAnnotationSet(Long lrID, AnnotationSet aset) creates an entry for annotation set in the database
protected Long	createDoc(Long _lrID, URL _docURL, String _docEncoding, Long _docStartOffset, Long _docEndOffset, Boolean _docIsMarkupAware, Long _corpusID) helper for adopt never call directly
protected void	createFeatures(Long entityID, int entityType, FeatureMap features) helper metod iterates a FeatureMap and creates all its features in the database
protected void	createFeaturesBulk(Long entityID, int entityType, FeatureMap features) helper metod iterates a FeatureMap and creates all its features in the database since it uses Oracle VARRAYs the roundtrips between the client and the server are minimized make sure the two types STRING_ARRAY and INT_ARRAY have the same name in the PL/SQL files also when referencing the types always use the schema owner in upper case because the jdbc driver is buggy (see MetaLink note if u care)
protected Long	createLR(String lrType, String lrName, SecurityInfo si, Long lrParentID) helper for adopt() never call directly
protected void	deleteCorpus(Long lrId) helper method for delete() never call it directly beause proper events will not be fired
protected void	deleteDocument(Long lrId) helper method for delete() never call it directly beause proper events will not be fired
boolean	equals(Object obj) checks if two databases are identical
List	findDocIdsByAnn(List constraints, int limitcount)
List	findLrIds(List constraints) Get a list of LRs that satisfy some set or restrictions
List	findLrIds(List constraints, String lrType) Get a list of LRs IDs that satisfy some set or restrictions and are of a particular type
List	findLrIds(List constraints, String lrType, List orderByConstraints, int limitcount) Get a list of LRs IDs that satisfy some set or restrictions and are of a particular type
long	getLrsCount(List constraints, String lrType) Return count of LRs which matches the constraints.
String	getStorageUrl() Get the URL for the underlying storage mechanism.
boolean	isAutoSaving() Get the autosaving behaviour of the LR.
boolean	lockLr(LanguageResource lr) Try to acquire exlusive lock on a resource from the persistent store.
void	open() Open a connection to the data store.
static Object	readBLOB(Blob src) reads the content of the specified BLOB object and returns the object contained.
static void	readCLOB(Clob src, StringBuffer dest) reads the content of a CLOB into the specified StringBuffer
protected FeatureMap	readFeatures(Long entityID, int entityType) reads the features of an entity entities are of type LR or Annotation
void	setAutoSaving(boolean autoSaving) Set method for the autosaving behaviour of the data store.
void	setSecurityInfo(LanguageResource lr, SecurityInfo si) set security information for LR .
void	setStorageUrl(String storageUrl) Set the URL for the underlying storage mechanism.
Long	timestamp() Gets a timestamp marker that will be used for all changes made in the database so that subsequent calls to deleteSince() could restore (partly) the database state as it was before the update.
void	unlockLr(LanguageResource lr) Releases the exlusive lock on a resource from the persistent store.
protected void	updateDocumentContent(Long docID, DocumentContent content) updates the content of the document if it is binary or a long string (that does not fit into VARCHAR2)
static void	writeBLOB(Object src, Blob dest) writes the specified object into the BLOB NOTE: the object should be serializable
static void	writeCLOB(StringBuffer src, Clob dest) writes the content of a StringBuffer into the specified CLOB object
static void	writeCLOB(String src, Clob dest) writes the content of a String into the specified CLOB object

Methods inherited from class gate.persist.JDBCDataStore

_adopt, _sync, _syncAddedAnnotations, _syncAnnotations, _syncAnnotationSets, _syncChangedAnnotations, _syncRemovedAnnotations, addDatastoreListener, adopt, beginTrans, canReadLR, canWriteLR, commitTrans, createCorpus, createDocument, createDocument, datastoreClosed, datastoreCreated, datastoreOpened, delete, delete, deleteSince, findFeatureType, fireResourceAdopted, fireResourceDeleted, fireResourceWritten, getComment, getDatabaseID, getIconName, getLockingUser, getLockingUser, getLr, getLrIds, getLrName, getLrNames, getLrTypes, getName, getSecurityInfo, getSession, readDatabaseID, removeDatastoreListener, resourceLoaded, resourceRenamed, resourceUnloaded, rollbackTrans, setName, setSession, sync, syncCorpus, syncDocument, unloadLR

Methods inherited from class gate.util.AbstractFeatureBearer

getFeatures, setFeatures

Methods inherited from class java.lang.Object

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

Methods inherited from interface gate.util.FeatureBearer

getFeatures, setFeatures

Constructor Detail

OracleDataStore

public OracleDataStore()

default constructor - just call the super constructor (may change in the future)

Method Detail

setStorageUrl

public void setStorageUrl(String storageUrl)
                   throws PersistenceException

Set the URL for the underlying storage mechanism.

Specified by:

setStorageUrl in interface DataStore

Overrides:

setStorageUrl in class JDBCDataStore

Throws:

PersistenceException

getStorageUrl

public String getStorageUrl()

Get the URL for the underlying storage mechanism.

Specified by:

getStorageUrl in interface DataStore

Overrides:

getStorageUrl in class JDBCDataStore

create

public void create()
            throws PersistenceException,
                   UnsupportedOperationException

Create a new data store. NOTE: for some data stores creation is an system administrator task; in such cases this method will throw an UnsupportedOperationException.

Specified by:

create in interface DataStore

Overrides:

create in class JDBCDataStore

Throws:

PersistenceException

UnsupportedOperationException

open

public void open()
          throws PersistenceException

Open a connection to the data store.

Specified by:

open in interface DataStore

Overrides:

open in class JDBCDataStore

Throws:

PersistenceException

close

public void close()
           throws PersistenceException

Close the data store.

Specified by:

close in interface DataStore

Overrides:

close in class JDBCDataStore

Throws:

PersistenceException

deleteDocument

protected void deleteDocument(Long lrId)
                       throws PersistenceException

helper method for delete() never call it directly beause proper events will not be fired

Specified by:

deleteDocument in class JDBCDataStore

Throws:

PersistenceException

deleteCorpus

protected void deleteCorpus(Long lrId)
                     throws PersistenceException

helper method for delete() never call it directly beause proper events will not be fired

Specified by:

deleteCorpus in class JDBCDataStore

Throws:

PersistenceException

setAutoSaving

public void setAutoSaving(boolean autoSaving)
                   throws UnsupportedOperationException,
                          PersistenceException

Set method for the autosaving behaviour of the data store. NOTE: many types of datastore have no auto-save function, in which case this will throw an UnsupportedOperationException.

Specified by:

setAutoSaving in interface DataStore

Overrides:

setAutoSaving in class JDBCDataStore

Throws:

UnsupportedOperationException

PersistenceException

isAutoSaving

public boolean isAutoSaving()

Get the autosaving behaviour of the LR.

Specified by:

isAutoSaving in interface DataStore

Overrides:

isAutoSaving in class JDBCDataStore

createLR

protected Long createLR(String lrType,
                        String lrName,
                        SecurityInfo si,
                        Long lrParentID)
                 throws PersistenceException,
                        SecurityException

helper for adopt() never call directly

Specified by:

createLR in class JDBCDataStore

Throws:

PersistenceException

SecurityException

updateDocumentContent

protected void updateDocumentContent(Long docID,
                                     DocumentContent content)
                              throws PersistenceException

updates the content of the document if it is binary or a long string (that does not fit into VARCHAR2)

Specified by:

updateDocumentContent in class JDBCDataStore

Throws:

PersistenceException

createDoc

protected Long createDoc(Long _lrID,
                         URL _docURL,
                         String _docEncoding,
                         Long _docStartOffset,
                         Long _docEndOffset,
                         Boolean _docIsMarkupAware,
                         Long _corpusID)
                  throws PersistenceException

helper for adopt never call directly

Specified by:

createDoc in class JDBCDataStore

Throws:

PersistenceException

createAnnotationSet

protected void createAnnotationSet(Long lrID,
                                   AnnotationSet aset)
                            throws PersistenceException

creates an entry for annotation set in the database

Specified by:

createAnnotationSet in class JDBCDataStore

Throws:

PersistenceException

timestamp

public Long timestamp()
               throws PersistenceException

Gets a timestamp marker that will be used for all changes made in the database so that subsequent calls to deleteSince() could restore (partly) the database state as it was before the update. NOTE: Restoring the previous state may not be possible at all (i.e. if DELETE is performed)

Specified by:

timestamp in interface DatabaseDataStore

Overrides:

timestamp in class JDBCDataStore

Throws:

PersistenceException

canAccessLR

protected boolean canAccessLR(Long lrID,
                              int mode)
                       throws PersistenceException,
                              SecurityException

Checks if the user (identified by the sessionID) has some access (read/write) to the LR

Overrides:

canAccessLR in class JDBCDataStore

Throws:

PersistenceException

SecurityException

readCLOB

public static void readCLOB(Clob src,
                            StringBuffer dest)
                     throws SQLException,
                            IOException

reads the content of a CLOB into the specified StringBuffer

Throws:

SQLException

IOException

writeCLOB

public static void writeCLOB(String src,
                             Clob dest)
                      throws SQLException,
                             IOException

writes the content of a String into the specified CLOB object

Throws:

SQLException

IOException

writeCLOB

public static void writeCLOB(StringBuffer src,
                             Clob dest)
                      throws SQLException,
                             IOException

writes the content of a StringBuffer into the specified CLOB object

Throws:

SQLException

IOException

readBLOB

public static Object readBLOB(Blob src)
                       throws SQLException,
                              IOException,
                              ClassNotFoundException

reads the content of the specified BLOB object and returns the object contained. NOTE: the BLOB is expected to contain serializable objects, not just any binary stream

Throws:

SQLException

IOException

ClassNotFoundException

writeBLOB

public static void writeBLOB(Object src,
                             Blob dest)
                      throws SQLException,
                             IOException

writes the specified object into the BLOB NOTE: the object should be serializable

Throws:

SQLException

IOException

createFeatures

protected void createFeatures(Long entityID,
                              int entityType,
                              FeatureMap features)
                       throws PersistenceException

helper metod iterates a FeatureMap and creates all its features in the database

Specified by:

createFeatures in class JDBCDataStore

Throws:

PersistenceException

createFeaturesBulk

protected void createFeaturesBulk(Long entityID,
                                  int entityType,
                                  FeatureMap features)
                           throws PersistenceException

helper metod iterates a FeatureMap and creates all its features in the database since it uses Oracle VARRAYs the roundtrips between the client and the server are minimized make sure the two types STRING_ARRAY and INT_ARRAY have the same name in the PL/SQL files also when referencing the types always use the schema owner in upper case because the jdbc driver is buggy (see MetaLink note if u care)

Specified by:

createFeaturesBulk in class JDBCDataStore

Throws:

PersistenceException

setSecurityInfo

public void setSecurityInfo(LanguageResource lr,
                            SecurityInfo si)
                     throws PersistenceException,
                            SecurityException

set security information for LR .

Throws:

PersistenceException

SecurityException

readFeatures

protected FeatureMap readFeatures(Long entityID,
                                  int entityType)
                           throws PersistenceException

reads the features of an entity entities are of type LR or Annotation

Specified by:

readFeatures in class JDBCDataStore

Throws:

PersistenceException

equals

public boolean equals(Object obj)

checks if two databases are identical

Overrides:

equals in class Object

See Also:

NOTE: the same database may be represented by different OracleDataStore instances but the IDs will be the same

_syncLR

protected void _syncLR(LanguageResource lr)
                throws PersistenceException,
                       SecurityException

helper for sync() NEVER call directly

Specified by:

_syncLR in class JDBCDataStore

Throws:

PersistenceException

SecurityException

_syncDocumentHeader

protected void _syncDocumentHeader(Document doc)
                            throws PersistenceException

helper for sync() - never call directly

Specified by:

_syncDocumentHeader in class JDBCDataStore

Throws:

PersistenceException

_syncDocumentContent

protected void _syncDocumentContent(Document doc)
                             throws PersistenceException

helper for sync() - never call directly

Specified by:

_syncDocumentContent in class JDBCDataStore

Throws:

PersistenceException

_syncRemovedDocumentsFromCorpus

protected void _syncRemovedDocumentsFromCorpus(List docLRIDs,
                                               Long corpLRID)
                                        throws PersistenceException

helper for sync() - never call directly

Specified by:

_syncRemovedDocumentsFromCorpus in class JDBCDataStore

Throws:

PersistenceException

_syncFeatures

protected void _syncFeatures(LanguageResource lr)
                      throws PersistenceException

helper for sync() - never call directly

Specified by:

_syncFeatures in class JDBCDataStore

Throws:

PersistenceException

lockLr

public boolean lockLr(LanguageResource lr)
               throws PersistenceException,
                      SecurityException

Try to acquire exlusive lock on a resource from the persistent store. Always call unlockLR() when the lock is no longer needed

Throws:

PersistenceException

SecurityException

unlockLr

public void unlockLr(LanguageResource lr)
              throws PersistenceException,
                     SecurityException

Releases the exlusive lock on a resource from the persistent store.

Throws:

PersistenceException

SecurityException

addDocumentToCorpus

protected void addDocumentToCorpus(Long docID,
                                   Long corpID)
                            throws PersistenceException,
                                   SecurityException

adds document to corpus in the database if the document is already part of the corpus nothing changes

Specified by:

addDocumentToCorpus in class JDBCDataStore

Throws:

PersistenceException

SecurityException

findLrIds

public List findLrIds(List constraints)
               throws PersistenceException

Get a list of LRs that satisfy some set or restrictions

Specified by:

findLrIds in interface DataStore

Specified by:

findLrIds in class JDBCDataStore

Parameters:

constraints - list of Restriction objects

Throws:

PersistenceException

findLrIds

public List findLrIds(List constraints,
                      String lrType)
               throws PersistenceException

Get a list of LRs IDs that satisfy some set or restrictions and are of a particular type

Specified by:

findLrIds in interface DataStore

Specified by:

findLrIds in class JDBCDataStore

Parameters:

constraints - list of Restriction objects

lrType - type of Lrs. DBHelper.DOCUMENT_CLASS or DBHelper.CORPUS_CLASS

Throws:

PersistenceException

findLrIds

public List findLrIds(List constraints,
                      String lrType,
                      List orderByConstraints,
                      int limitcount)
               throws PersistenceException

Get a list of LRs IDs that satisfy some set or restrictions and are of a particular type

Parameters:

constraints - list of Restriction objects

lrType - type of Lrs. DBHelper.DOCUMENT_CLASS or DBHelper.CORPUS_CLASS

orderByConstraints - liat of OrderByRestriction objects

limitcount - limit returning objects -1 for unlimited

Throws:

PersistenceException

getLrsCount

public long getLrsCount(List constraints,
                        String lrType)
                 throws PersistenceException

Return count of LRs which matches the constraints.

Parameters:

constraints - list of Restriction objects

lrType - type of Lrs. DBHelper.DOCUMENT_CLASS or DBHelper.CORPUS_CLASS

Throws:

PersistenceException

findDocIdsByAnn

public List findDocIdsByAnn(List constraints,
                            int limitcount)
                     throws PersistenceException

Throws:

PersistenceException