DataSourceIndex (Apache OODT 0.7 API)

java.lang.Object
- org.apache.oodt.cas.catalog.struct.impl.index.DataSourceIndex

All Implemented Interfaces:

Index, IngestService, QueryService

Direct Known Subclasses:

InMemoryIndex
```
public class DataSourceIndex
extends Object
implements Index, IngestService, QueryService
```
DataSource Indexer which supports both ingest and query

Version:

$Revision$

Author:

bfoster

Field Summary

Fields
Modifier and Type Field and Description
protected DataSource dataSource
protected boolean useUTF8

Fields
Modifier and Type	Field and Description
`protected DataSource`	`dataSource`
`protected boolean`	`useUTF8`

Constructor Summary

Constructors
Constructor and Description
DataSourceIndex(String user, String pass, String driver, String jdbcUrl, boolean useUTF8)

Constructors
Constructor and Description
`DataSourceIndex(String user, String pass, String driver, String jdbcUrl, boolean useUTF8)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`delete(TransactionId<?> transactionId)` Deletes all TermBuckets attached to given TransactionId -- there should be no trace of given transaction after this method is called.
`Map<TransactionId<?>,List<TermBucket>>`	`getBuckets(List<TransactionId<?>> transactionIds)` Does the same as getBuckets(TransactionId), except is performed over a list of TransactionIds
`List<TermBucket>`	`getBuckets(TransactionId<?> transactionId)` Returns a List of TermBuckets ingested for a given TransactionId
`protected int`	`getNumOfTransactions()`
`List<TransactionId<?>>`	`getPage(IndexPager indexPage)` Returns a list of TransactionIds associated with the given Index page.
`IndexPager`	`getPager(PageInfo pageInfo)`
`Properties`	`getProperties()`
`String`	`getProperty(String key)`
`TransactionIdFactory`	`getTransactionIdFactory()`
`boolean`	`hasTransactionId(TransactionId<?> transactionId)`
`IngestReceipt`	`ingest(List<TermBucket> termBuckets)` Indexes the given TermBucket to a TransactionId, and returns a IngestReceipt
`List<IngestReceipt>`	`query(QueryExpression queryExpression)` Returns all the TransactionIds that fall under the given query
`List<IngestReceipt>`	`query(QueryExpression queryExpression, int startIndex, int endIndex)` Returns the results of the given query such that: [startIndex, endIndex)
`boolean`	`reduce(TransactionId<?> transactionId, List<TermBucket> termBuckets)` Deletes only the Terms in the given TermBuckets from the given TransactionId
`int`	`sizeOf(QueryExpression queryExpression)` Returns the number of results found for the given query
`IngestReceipt`	`update(TransactionId<?> transactionId, List<TermBucket> termBuckets)` TermBucket updates to given TransactionId.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - dataSource
```
protected DataSource dataSource
```
  - useUTF8
```
protected boolean useUTF8
```
- Constructor Detail
  - DataSourceIndex
```
public DataSourceIndex(String user,
               String pass,
               String driver,
               String jdbcUrl,
               boolean useUTF8)
```
- Method Detail
  - getPager
```
public IndexPager getPager(PageInfo pageInfo)
                    throws CatalogIndexException
```
    Throws:
    
    CatalogIndexException
  - getNumOfTransactions
```
protected int getNumOfTransactions()
                            throws CatalogIndexException
```
    Throws:
    
    CatalogIndexException
  - getPage
```
public List<TransactionId<?>> getPage(IndexPager indexPage)
                               throws CatalogIndexException
```
    Returns a list of TransactionIds associated with the given Index page.
    
    Specified by:
    
    getPage in interface Index
    
    Parameters:
    indexPage - The page for which TransactionIds will be returned
    
    Returns:
    A page of TransactionIds, if page does not exist, then returns null.
    
    Throws:
    
    CatalogIndexException
  - getProperties
```
public Properties getProperties()
                         throws CatalogIndexException
```
    Specified by:
    
    getProperties in interface Index
    
    Throws:
    
    CatalogIndexException
  - getProperty
```
public String getProperty(String key)
                   throws CatalogIndexException
```
    Specified by:
    
    getProperty in interface Index
    
    Throws:
    
    CatalogIndexException
  - getTransactionIdFactory
```
public TransactionIdFactory getTransactionIdFactory()
                                             throws CatalogIndexException
```
    Specified by:
    
    getTransactionIdFactory in interface Index
    
    Returns:
    
    Throws:
    
    CatalogIndexException
  - hasTransactionId
```
public boolean hasTransactionId(TransactionId<?> transactionId)
                         throws CatalogIndexException
```
    Specified by:
    
    hasTransactionId in interface Index
    
    Returns:
    
    Throws:
    
    CatalogIndexException
  - delete
```
public boolean delete(TransactionId<?> transactionId)
               throws IngestServiceException
```
    Deletes all TermBuckets attached to given TransactionId -- there should be no trace of given transaction after this method is called.
    
    Specified by:
    
    delete in interface IngestService
    
    Parameters:
    transactionId - The ID for given transaction which should be erased
    
    Throws:
    
    IngestServiceException - Any error
  - ingest
```
public IngestReceipt ingest(List<TermBucket> termBuckets)
                     throws IngestServiceException
```
    Indexes the given TermBucket to a TransactionId, and returns a IngestReceipt
    
    Specified by:
    
    ingest in interface IngestService
    
    Parameters:
    termBuckets - The List of TermBucket to be ingested
    
    Returns:
    IngestReceipt Receipt of ingest
    
    Throws:
    
    IngestServiceException - Any error
  - reduce
```
public boolean reduce(TransactionId<?> transactionId,
             List<TermBucket> termBuckets)
               throws IngestServiceException
```
    Deletes only the Terms in the given TermBuckets from the given TransactionId
    
    Specified by:
    
    reduce in interface IngestService
    
    Parameters:
    transactionId - The TransactionId for which Terms will be deleted
    termBuckets - The reduction set of Terms for each TermBucket
    
    Throws:
    
    IngestServiceException - Any error
  - update
```
public IngestReceipt update(TransactionId<?> transactionId,
                   List<TermBucket> termBuckets)
                     throws IngestServiceException
```
    TermBucket updates to given TransactionId. A new TransactionId can be returned in IngestReceipt if so desired and it will automatically get remapped by CatalogService. Existing metadata for given TransactionId should not be deleted, just the terms in the given term buckets should be modified. For a complete re-ingest, one should instead delete() then ingest().
    
    Specified by:
    
    update in interface IngestService
    
    Throws:
    
    IngestServiceException
  - getBuckets
```
public List<TermBucket> getBuckets(TransactionId<?> transactionId)
                            throws QueryServiceException
```
    Returns a List of TermBuckets ingested for a given TransactionId
    
    Specified by:
    
    getBuckets in interface QueryService
    
    Parameters:
    transactionId - The TransactionId in question
    
    Returns:
    A List of TermBuckets for the given TransactionId or empty list if no record of the give TranactionId exists
    
    Throws:
    
    QueryServiceException
  - getBuckets
```
public Map<TransactionId<?>,List<TermBucket>> getBuckets(List<TransactionId<?>> transactionIds)
                                                  throws QueryServiceException
```
    Does the same as getBuckets(TransactionId), except is performed over a list of TransactionIds
    
    Specified by:
    
    getBuckets in interface QueryService
    
    Parameters:
    transactionIds - A List of TransactionIds for which TermBuckets are wanted
    
    Returns:
    A Map of TransactionIds to TermBuckets
    
    Throws:
    
    QueryServiceException
  - query
```
public List<IngestReceipt> query(QueryExpression queryExpression)
                          throws QueryServiceException
```
    Returns all the TransactionIds that fall under the given query
    
    Specified by:
    
    query in interface QueryService
    
    Returns:
    Returns a List of TransactionIds that meet the query, otherwise an empty List is no TransactionIds are found for the given query
    
    Throws:
    
    QueryServiceException
  - query
```
public List<IngestReceipt> query(QueryExpression queryExpression,
                        int startIndex,
                        int endIndex)
                          throws QueryServiceException
```
    Description copied from interface: QueryService
    
    Returns the results of the given query such that: [startIndex, endIndex)
    
    Specified by:
    
    query in interface QueryService
    
    Parameters:
    queryExpression - The query for which results will be returned
    startIndex - The start index of subset of results to be returned
    endIndex - The end index of the subset of results to be returned
    
    Returns:
    The results of the given query such that: [startIndex, endIndex)
    
    Throws:
    
    QueryServiceException - on an error
  - sizeOf
```
public int sizeOf(QueryExpression queryExpression)
           throws QueryServiceException
```
    Description copied from interface: QueryService
    
    Returns the number of results found for the given query
    
    Specified by:
    
    sizeOf in interface QueryService
    
    Parameters:
    queryExpression - The query whose size in question
    
    Returns:
    The number of results found for the given query
    
    Throws:
    
    QueryServiceException - on an error

Class DataSourceIndex

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dataSource

useUTF8

Constructor Detail

DataSourceIndex

Method Detail

getPager

getNumOfTransactions

getPage

getProperties

getProperty

getTransactionIdFactory

hasTransactionId

delete

ingest

reduce

update

getBuckets

getBuckets

query

query

sizeOf