org.dspace.app.bulkedit

Class DSpaceCSV

java.lang.Object

org.dspace.app.bulkedit.DSpaceCSV

All Implemented Interfaces:

java.io.Serializable

public class DSpaceCSV
extends java.lang.Object
implements java.io.Serializable

Utility class to read and write CSV files ************** Important Note ************** This class has been made serializable, as it is stored in a Session. Is it wise to: a) be putting this into a user's session? b) holding an entire CSV upload in memory?

Author:

Stuart Lewis

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	authoritySeparator The authority separator (defaults to double colon '::')
protected static java.lang.String	escapedAuthoritySeparator The authority separator in an escaped form for using in regexes
protected static java.lang.String	escapedFieldSeparator The field separator in an escaped form for using in regexes
protected static java.lang.String	escapedValueSeparator The value separator in an escaped form for using in regexes
protected static java.lang.String	fieldSeparator The field separator (defaults to comma)
protected static java.lang.String	valueSeparator The value separator (defaults to double pipe '||')

Constructor Summary

Constructors

Constructor and Description
DSpaceCSV(boolean exportAll) Create a new instance of a CSV line holder
DSpaceCSV(java.io.File f, Context c) Create a new instance, reading the lines in from file

Method Summary

Methods

Modifier and Type	Method and Description
void	addItem(Item i) Add a DSpace item to the CSV file
void	addItem(java.lang.String line) Add an item to the CSV file, from a CSV line of elements
java.util.List<DSpaceCSVLine>	getCSVLines() Get the lines in CSV holders
java.lang.String[]	getCSVLinesAsStringArray() Get the CSV lines as an array of CSV formatted strings
java.util.List<java.lang.String>	getHeadings() Get the headings used in this CSV file
boolean	hasActions() Decide if this CSV file has an 'action' (case-dependent!) header.
void	save(java.lang.String filename) Save the CSV file to the given filename
java.lang.String	toString() Return the csv file as one long formatted string

Methods inherited from class java.lang.Object

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

Field Detail

valueSeparator

protected static java.lang.String valueSeparator

The value separator (defaults to double pipe '||')

escapedValueSeparator

protected static java.lang.String escapedValueSeparator

The value separator in an escaped form for using in regexes

fieldSeparator

protected static java.lang.String fieldSeparator

The field separator (defaults to comma)

escapedFieldSeparator

protected static java.lang.String escapedFieldSeparator

The field separator in an escaped form for using in regexes

authoritySeparator

protected static java.lang.String authoritySeparator

The authority separator (defaults to double colon '::')

escapedAuthoritySeparator

protected static java.lang.String escapedAuthoritySeparator

The authority separator in an escaped form for using in regexes

Constructor Detail

DSpaceCSV

public DSpaceCSV(boolean exportAll)

Create a new instance of a CSV line holder

Parameters:

exportAll - Whether to export all metadata such as handles and provenance information

DSpaceCSV

public DSpaceCSV(java.io.File f,
         Context c)
          throws java.lang.Exception

Create a new instance, reading the lines in from file

Parameters:

f - The file to read from

c - The DSpace Context

Throws:

java.lang.Exception - thrown if there is an error reading or processing the file

Method Detail

hasActions

public boolean hasActions()

Decide if this CSV file has an 'action' (case-dependent!) header.

Returns:

Whether or not there is an 'action' header

addItem

public final void addItem(Item i)
                   throws java.lang.Exception

Add a DSpace item to the CSV file

Parameters:

i - The DSpace item

Throws:

java.lang.Exception - if something goes wrong with adding the Item

addItem

public final void addItem(java.lang.String line)
                   throws java.lang.Exception

Add an item to the CSV file, from a CSV line of elements

Parameters:

line - The line of elements

Throws:

java.lang.Exception - Thrown if an error occurs when adding the item

getCSVLines

public final java.util.List<DSpaceCSVLine> getCSVLines()

Get the lines in CSV holders

Returns:

The lines

getCSVLinesAsStringArray

public final java.lang.String[] getCSVLinesAsStringArray()

Get the CSV lines as an array of CSV formatted strings

Returns:

the array of CSV formatted Strings

save

public final void save(java.lang.String filename)
                throws java.io.IOException

Save the CSV file to the given filename

Parameters:

filename - The filename to save the CSV file to

Throws:

java.io.IOException - Thrown if an error occurs when writing the file

getHeadings

public java.util.List<java.lang.String> getHeadings()

Get the headings used in this CSV file

Returns:

The headings

toString

public final java.lang.String toString()

Return the csv file as one long formatted string

Overrides:

toString in class java.lang.Object

Returns:

The formatted String as a csv