com.ibm.workplace.wcm.api
Class CSVDocumentListWriter

java.lang.Object
  com.ibm.workplace.wcm.api.CSVDocumentListWriter

All Implemented Interfaces:

DocumentListWriter

public class CSVDocumentListWriter
extends java.lang.Object
implements DocumentListWriter

Implementation of a DocumentListWriter that writes a document list as comma separated value list with each document in a single row.

Field Summary

static java.lang.String	COPYRIGHT Copyright statement
static java.lang.String	DEFAULT_SEPARATOR The default separator "," used when no other separator string was set

Constructor Summary

CSVDocumentListWriter(java.io.Writer delegate)
Create a new CSVDocumentListWriter object that writes to the passed character stream and uses the default separator DEFAULT_SEPARATOR

CSVDocumentListWriter(java.io.Writer delegate, java.lang.String separator)
Create a new CSVDocumentListWriter object that writes to the passed character stream and uses the passed separator.

Method Summary

void	writeEndDocument() Write an element for the end of a new document entry in the document list
void	writeEndDocumentList() Write an element for the end of a document list.
void	writeEndProperty() Write an element for the end of a property entry for a document entry in the document list
void	writeEndType() Write an element for the end of a document type section within the document list
void	writeStartDocument() Write an element for the start of a new document entry in the document list
void	writeStartDocumentList(java.util.Locale locale) Writes an element for the start of the document list.
void	writeStartProperty() Write an element for the start of a property entry for a document entry in the document list
void	writeStartType(java.lang.String type) Write an element for the start of a new document type section within the document list
void	writeValue(java.lang.String value) Write a value to the document list

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

Copyright statement

See Also:

Constant Field Values

DEFAULT_SEPARATOR

public static final java.lang.String DEFAULT_SEPARATOR

The default separator "," used when no other separator string was set

See Also:

Constant Field Values

Constructor Detail

CSVDocumentListWriter

public CSVDocumentListWriter(java.io.Writer delegate)

Create a new CSVDocumentListWriter object that writes to the passed character stream and uses the default separator DEFAULT_SEPARATOR

Parameters:

delegate - The underlying character stream to write to

CSVDocumentListWriter

public CSVDocumentListWriter(java.io.Writer delegate,
                             java.lang.String separator)

Create a new CSVDocumentListWriter object that writes to the passed character stream and uses the passed separator. Make sure to handle escaping of separator characters in values when using a separator that matches any of alphanumeric (a-zA-Z0-9) characters, spaces, and the following: "$-_.!()," as those character can be used in document names.

Parameters:

delegate - The underlying character stream to write to

separator - The string used to separate properties

Method Detail

writeEndDocument

public void writeEndDocument()
                      throws java.io.IOException

Description copied from interface: DocumentListWriter

Write an element for the end of a new document entry in the document list

Specified by:

writeEndDocument in interface DocumentListWriter

Throws:

java.io.IOException - If unable to write to underlying stream

writeEndDocumentList

public void writeEndDocumentList()
                          throws java.io.IOException

Description copied from interface: DocumentListWriter

Write an element for the end of a document list.

Specified by:

writeEndDocumentList in interface DocumentListWriter

Throws:

java.io.IOException - If unable to write to underlying stream

writeEndProperty

public void writeEndProperty()
                      throws java.io.IOException

Description copied from interface: DocumentListWriter

Write an element for the end of a property entry for a document entry in the document list

Specified by:

writeEndProperty in interface DocumentListWriter

Throws:

java.io.IOException - If unable to write to underlying stream

writeEndType

public void writeEndType()
                  throws java.io.IOException

Description copied from interface: DocumentListWriter

Write an element for the end of a document type section within the document list

Specified by:

writeEndType in interface DocumentListWriter

Throws:

java.io.IOException - If unable to write to underlying stream

writeStartDocument

public void writeStartDocument()
                        throws java.io.IOException

Description copied from interface: DocumentListWriter

Write an element for the start of a new document entry in the document list

Specified by:

writeStartDocument in interface DocumentListWriter

Throws:

java.io.IOException - If unable to write to underlying stream

writeStartDocumentList

public void writeStartDocumentList(java.util.Locale locale)
                            throws java.io.IOException

Description copied from interface: DocumentListWriter

Writes an element for the start of the document list.

Specified by:

writeStartDocumentList in interface DocumentListWriter

Parameters:

locale - The language used to localize information in the list

Throws:

java.io.IOException - If unable to write to underlying stream

writeStartProperty

public void writeStartProperty()
                        throws java.io.IOException

Description copied from interface: DocumentListWriter

Write an element for the start of a property entry for a document entry in the document list

Specified by:

writeStartProperty in interface DocumentListWriter

Throws:

java.io.IOException - If unable to write to underlying stream

writeStartType

public void writeStartType(java.lang.String type)
                    throws java.io.IOException

Description copied from interface: DocumentListWriter

Write an element for the start of a new document type section within the document list

Specified by:

writeStartType in interface DocumentListWriter

Parameters:

type - The non-localized name of the type

Throws:

java.io.IOException - If unable to write to underlying stream

writeValue

public void writeValue(java.lang.String value)
                throws java.io.IOException

Description copied from interface: DocumentListWriter

Write a value to the document list

Specified by:

writeValue in interface DocumentListWriter

Parameters:

value - The value to write

Throws:

java.io.IOException - If unable to write to underlying stream