CASProductHandler (Apache OODT 0.7 API)

java.lang.Object
- org.apache.oodt.cas.product.CASProductHandler

All Implemented Interfaces:

LargeProductQueryHandler, QueryHandler
```
public class CASProductHandler
extends Object
implements LargeProductQueryHandler
```
Version:

$Revision$
Describe your class here
.

Author:

mattmann

Constructor Summary

Constructors
Constructor and Description
CASProductHandler()

Constructors
Constructor and Description
`CASProductHandler()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close(String id)` Close off a product.
`XMLQuery`	`query(XMLQuery query)` Run a query.
`byte[]`	`retrieveChunk(String id, long offset, int length)` Retrieve a chunk of a product.

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

- Constructor Detail
  - CASProductHandler
```
public CASProductHandler()
                  throws MalformedURLException,
                         ConnectionException
```
    Throws:
    
    MalformedURLException
    
    ConnectionException
- Method Detail
  - query
```
public XMLQuery query(XMLQuery query)
               throws ProductException
```
    Description copied from interface: QueryHandler
    
    Run a query.
    
    Specified by:
    
    query in interface QueryHandler
    
    Parameters:
    query - The query.
    
    Returns:
    The response.
    
    Throws:
    
    ProductException - if an error occurs.
  - close
```
public void close(String id)
           throws ProductException
```
    Description copied from interface: LargeProductQueryHandler
    
    Close off a product. This method indicates that the product is no longer required and its resources can be freed by the query handler. If the ID is unknown, no untoward action is required. It should throw an exception if there is an error during the resource release (such as an IOException when closing a file.
    
    Specified by:
    
    close in interface LargeProductQueryHandler
    
    Parameters:
    id - Product ID.
    
    Throws:
    
    ProductException - if an error occurs.
  - retrieveChunk
```
public byte[] retrieveChunk(String id,
                   long offset,
                   int length)
                     throws ProductException
```
    Description copied from interface: LargeProductQueryHandler
    
    Retrieve a chunk of a product. The product is identified by a string ID. The query handler should return a binary chunk of the product using the given offset and length. If the ID isn't recognized, it should return null. It should throw an exception if retrieval fails for some reason.
    
    Specified by:
    
    retrieveChunk in interface LargeProductQueryHandler
    
    Parameters:
    id - Product ID.
    offset - Where in the product to get a chunk of it.
    length - How much of the product to get.
    
    Returns:
    A chunk, or null if the id is unknown.
    
    Throws:
    
    ProductException - if an error occurs.

Class CASProductHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CASProductHandler

Method Detail

query

close

retrieveChunk