gate.persist
Class OracleDataStore

java.lang.Object
  extended bygate.util.AbstractFeatureBearer
      extended bygate.persist.JDBCDataStore
          extended bygate.persist.OracleDataStore
All Implemented Interfaces:
CreoleListener, DatabaseDataStore, DataStore, EventListener, FeatureBearer, NameBearer, Serializable

public class OracleDataStore
extends JDBCDataStore

See Also:
Serialized Form

Field Summary
 
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
 void close()
          Close the data store.
 void create()
          Create a new data store.
 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
 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.
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
addDatastoreListener, adopt, beginTrans, canReadLR, canWriteLR, commitTrans, datastoreClosed, datastoreCreated, datastoreOpened, delete, delete, deleteSince, getComment, getDatabaseID, getIconName, getLr, getLrIds, getLrName, getLrNames, getLrTypes, getName, getSecurityInfo, getSession, removeDatastoreListener, resourceLoaded, resourceRenamed, resourceUnloaded, rollbackTrans, setName, setSession, sync
 
Methods inherited from class gate.util.AbstractFeatureBearer
getFeatures, setFeatures
 
Methods inherited from class java.lang.Object
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

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

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

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

setSecurityInfo

public void setSecurityInfo(LanguageResource lr,
                            SecurityInfo si)
                     throws PersistenceException,
                            SecurityException
set security information for LR .

Throws:
PersistenceException
SecurityException

equals

public boolean equals(Object obj)
checks if two databases are identical

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

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

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