org.dspace.app.xmlui.cocoon

Class SearchMetadataExportReader

java.lang.Object

org.apache.cocoon.util.AbstractLogEnabled

org.apache.cocoon.reading.AbstractReader

org.dspace.app.xmlui.cocoon.SearchMetadataExportReader

All Implemented Interfaces:

org.apache.avalon.excalibur.pool.Poolable, org.apache.avalon.excalibur.pool.Recyclable, org.apache.cocoon.reading.Reader, org.apache.cocoon.sitemap.SitemapModelComponent, org.apache.cocoon.sitemap.SitemapOutputComponent

public class SearchMetadataExportReader
extends org.apache.cocoon.reading.AbstractReader
implements org.apache.avalon.excalibur.pool.Recyclable

SearchMetadataExportReader that generates a CSV of search result metadata using MetadataExport.

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	BUFFER_SIZE How big a buffer should we use when reading from the bitstream before writing to the HTTP response?
protected static int	expires When should a download expire in milliseconds.
protected org.apache.cocoon.environment.Request	request The Cocoon request
protected org.apache.cocoon.environment.Response	response The Cocoon response

Fields inherited from class org.apache.cocoon.reading.AbstractReader

objectModel, out, parameters, resolver, source

Fields inherited from interface org.apache.cocoon.reading.Reader

ROLE

Constructor Summary

Constructors

Constructor and Description
SearchMetadataExportReader()

Method Summary

Methods

Modifier and Type	Method and Description
DSpaceCSV	exportMetadata(Context context, Map objectModel, String query, String scopeString, String filters) Save and return the search results as a CSV file.
void	generate() Write the CSV.
void	recycle() Recycle
static int	safeLongToInt(long l)
void	setup(org.apache.cocoon.environment.SourceResolver resolver, Map objectModel, String src, org.apache.avalon.framework.parameters.Parameters par) Set up the export reader.

Methods inherited from class org.apache.cocoon.reading.AbstractReader

getLastModified, getMimeType, setOutputStream, shouldSetContentLength

Methods inherited from class org.apache.cocoon.util.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

protected static final int BUFFER_SIZE

How big a buffer should we use when reading from the bitstream before writing to the HTTP response?

See Also:

Constant Field Values

expires

protected static final int expires

When should a download expire in milliseconds. This should be set to some low value just to prevent someone hitting DSpace repeatedly from killing the server. Note: there are 60000 milliseconds in a minute. Format: minutes * seconds * milliseconds

See Also:

Constant Field Values

response

protected org.apache.cocoon.environment.Response response

The Cocoon response

request

protected org.apache.cocoon.environment.Request request

The Cocoon request

Constructor Detail

SearchMetadataExportReader

public SearchMetadataExportReader()

Method Detail

setup

public void setup(org.apache.cocoon.environment.SourceResolver resolver,
         Map objectModel,
         String src,
         org.apache.avalon.framework.parameters.Parameters par)
           throws org.apache.cocoon.ProcessingException,
                  SAXException,
                  IOException

Set up the export reader. See the class description for information on configuration options.

Specified by:

setup in interface org.apache.cocoon.sitemap.SitemapModelComponent

Overrides:

setup in class org.apache.cocoon.reading.AbstractReader

Parameters:

resolver - source resolver.

objectModel - Cocoon object model.

src - source to read.

par - Reader parameters.

Throws:

org.apache.cocoon.ProcessingException - on error.

SAXException - passed through.

IOException - passed through.

generate

public void generate()
              throws IOException,
                     SAXException,
                     org.apache.cocoon.ProcessingException

Write the CSV.

Specified by:

generate in interface org.apache.cocoon.reading.Reader

Throws:

IOException - passed through.

SAXException - passed through.

org.apache.cocoon.ProcessingException - passed through.

recycle

public void recycle()

Recycle

Specified by:

recycle in interface org.apache.avalon.excalibur.pool.Recyclable

Overrides:

recycle in class org.apache.cocoon.reading.AbstractReader

exportMetadata

public DSpaceCSV exportMetadata(Context context,
                       Map objectModel,
                       String query,
                       String scopeString,
                       String filters)
                         throws IOException,
                                UIException,
                                SearchServiceException,
                                SQLException

Save and return the search results as a CSV file.

Parameters:

context - session context.

objectModel - Cocoon object model.

query - search parameters.

scopeString - scope of the search.

filters - search filters.

Returns:

wrapper for the CSV file.

Throws:

IOException - passed through.

UIException - passed through.

SearchServiceException - passed through.

SQLException - passed through.

safeLongToInt

public static int safeLongToInt(long l)