org.xbib.marc.xml

Class MarcXchangeWriter

java.lang.Object

org.xbib.marc.xml.MarcContentHandler

org.xbib.marc.xml.MarcXchangeWriter

All Implemented Interfaces:

java.io.Closeable, java.io.Flushable, java.lang.AutoCloseable, MarcListener, MarcRecordListener, MarcXchangeConstants, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler

public class MarcXchangeWriter
extends MarcContentHandler
implements java.io.Flushable, java.io.Closeable

This MarcXchange Writer writes MarcXchange events to a StaX XML output stream or XML event consumer. Default output format is MarcXchange.

Field Summary

Fields inherited from class org.xbib.marc.xml.MarcContentHandler

content, format, listeners, marcListener, marcValueTransformers, recordCounter, stack, type

Fields inherited from interface org.xbib.marc.MarcXchangeConstants

BIBLIOGRAPHIC_TYPE, CODE_ATTRIBUTE, COLLECTION, CONTROLFIELD, DATAFIELD, FORMAT_ATTRIBUTE, HOLDINGS_TYPE, IND_ATTRIBUTE, LEADER, MARC21_FORMAT, MARC21_SCHEMA_LOCATION, MARC21_SCHEMA_URI, MARCXCHANGE_FORMAT, MARCXCHANGE_V1_NS_URI, MARCXCHANGE_V2_0_SCHEMA_LOCATION, MARCXCHANGE_V2_NS_URI, RECORD, SUBFIELD, TAG_ATTRIBUTE, TYPE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
MarcXchangeWriter(java.io.OutputStream out) Create a MarcXchange writer on an underlying output stream.
MarcXchangeWriter(java.io.OutputStream out, boolean indent) Create a MarcXchange writer on an underlying output stream.
MarcXchangeWriter(java.lang.String fileNamePattern, int splitlimit, int bufferSize, boolean compress, boolean indent) Create a MarcXchange writer in "split writer" mode.
MarcXchangeWriter(java.io.Writer writer) Create a MarcXchange writer on an underlying writer.
MarcXchangeWriter(java.io.Writer writer, boolean indent) Create a MarcXchange writer on an underlying writer.
MarcXchangeWriter(javax.xml.stream.util.XMLEventConsumer consumer) Write MarcXchange to an XML event consumer.

Method Summary

Modifier and Type	Method and Description
void	beginCollection() Begin of a record collection.
void	beginRecord(java.lang.String format, java.lang.String type) Begin of a record.
void	close()
void	endCollection() End of a collection.
void	endCustomElement(java.lang.String prefix, java.lang.String uri, java.lang.String localname)
void	endDocument()
void	endRecord() End of a record.
void	field(MarcField field) A field.
void	flush()
java.lang.Exception	getException()
void	leader(java.lang.String label) The leader (or label) of a record.
void	record(MarcRecord marcRecord) Receive a MARC Record.
MarcXchangeWriter	setFatalErrors(boolean fatalErrors)
MarcXchangeWriter	setFormat(java.lang.String format)
MarcXchangeWriter	setMarcListener(MarcListener listener) Set MARC listener for the default record type.
MarcXchangeWriter	setMarcValueTransformers(MarcValueTransformers marcValueTransformers) Set MARC field value transformer for transforming field values.
MarcXchangeWriter	setType(java.lang.String type)
void	startCustomElement(java.lang.String prefix, java.lang.String uri, java.lang.String localname)
void	startDocument()

Methods inherited from class org.xbib.marc.xml.MarcContentHandler

addNamespace, characters, endElement, endPrefixMapping, error, fatalError, getDefaultFormat, getDefaultType, getFormat, getRecordCounter, getType, ignorableWhitespace, isNamespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, setMarcFieldTransformers, setMarcListener, skippedEntity, startElement, startPrefixMapping, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object

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

Constructor Detail

MarcXchangeWriter

public MarcXchangeWriter(java.io.OutputStream out)
                  throws java.io.IOException

Create a MarcXchange writer on an underlying output stream.

Parameters:

out - the underlying output stream

Throws:

java.io.IOException - if writer can not be created

MarcXchangeWriter

public MarcXchangeWriter(java.io.OutputStream out,
                         boolean indent)
                  throws java.io.IOException

Create a MarcXchange writer on an underlying output stream.

Parameters:

out - the underlying output stream

indent - if true, indent MarcXchange output

Throws:

java.io.IOException - if writer can not be created

MarcXchangeWriter

public MarcXchangeWriter(java.io.Writer writer)
                  throws java.io.IOException

Create a MarcXchange writer on an underlying writer.

Parameters:

writer - the underlying writer

Throws:

java.io.IOException - if writer can not be created

MarcXchangeWriter

public MarcXchangeWriter(java.io.Writer writer,
                         boolean indent)
                  throws java.io.IOException

Create a MarcXchange writer on an underlying writer.

Parameters:

writer - the underlying writer

indent - if true, indent MarcXchange output

Throws:

java.io.IOException - if writer can not be created

MarcXchangeWriter

public MarcXchangeWriter(java.lang.String fileNamePattern,
                         int splitlimit,
                         int bufferSize,
                         boolean compress,
                         boolean indent)
                  throws java.io.IOException

Create a MarcXchange writer in "split writer" mode.

Parameters:

fileNamePattern - file name pattern

splitlimit - split write limit

bufferSize - buffer size

compress - if true, compress MarcXchange output

indent - if true, indent MarcXchange output

Throws:

java.io.IOException - if writer can not be created

MarcXchangeWriter

public MarcXchangeWriter(javax.xml.stream.util.XMLEventConsumer consumer)

Write MarcXchange to an XML event consumer.

Parameters:

consumer - an XML event consumer

Method Detail

setFormat

public MarcXchangeWriter setFormat(java.lang.String format)

Overrides:

setFormat in class MarcContentHandler

setType

public MarcXchangeWriter setType(java.lang.String type)

Overrides:

setType in class MarcContentHandler

setMarcValueTransformers

public MarcXchangeWriter setMarcValueTransformers(MarcValueTransformers marcValueTransformers)

Description copied from class: MarcContentHandler

Set MARC field value transformer for transforming field values.

Overrides:

setMarcValueTransformers in class MarcContentHandler

Parameters:

marcValueTransformers - the value transformer

Returns:

this handler

setFatalErrors

public MarcXchangeWriter setFatalErrors(boolean fatalErrors)

setMarcListener

public MarcXchangeWriter setMarcListener(MarcListener listener)

Description copied from class: MarcContentHandler

Set MARC listener for the default record type.

Overrides:

setMarcListener in class MarcContentHandler

Parameters:

listener - the MARC listener

Returns:

this handler

startDocument

public void startDocument()

Specified by:

startDocument in interface org.xml.sax.ContentHandler

Overrides:

startDocument in class MarcContentHandler

endDocument

public void endDocument()

Specified by:

endDocument in interface org.xml.sax.ContentHandler

Overrides:

endDocument in class MarcContentHandler

beginCollection

public void beginCollection()

Description copied from interface: MarcListener

Begin of a record collection.

Specified by:

beginCollection in interface MarcListener

Specified by:

beginCollection in interface MarcRecordListener

Overrides:

beginCollection in class MarcContentHandler

beginRecord

public void beginRecord(java.lang.String format,
                        java.lang.String type)

Description copied from interface: MarcListener

Begin of a record.

Specified by:

beginRecord in interface MarcListener

Overrides:

beginRecord in class MarcContentHandler

Parameters:

format - the record format

type - the record type

leader

public void leader(java.lang.String label)

Description copied from interface: MarcListener

The leader (or label) of a record.

Specified by:

leader in interface MarcListener

Overrides:

leader in class MarcContentHandler

Parameters:

label - the label

field

public void field(MarcField field)

Description copied from interface: MarcListener

A field.

Specified by:

field in interface MarcListener

Overrides:

field in class MarcContentHandler

Parameters:

field - the field.

endRecord

public void endRecord()

Description copied from interface: MarcListener

End of a record.

Specified by:

endRecord in interface MarcListener

Overrides:

endRecord in class MarcContentHandler

endCollection

public void endCollection()

Description copied from interface: MarcListener

End of a collection.

Specified by:

endCollection in interface MarcListener

Specified by:

endCollection in interface MarcRecordListener

Overrides:

endCollection in class MarcContentHandler

record

public void record(MarcRecord marcRecord)

Description copied from interface: MarcRecordListener

Receive a MARC Record.

Specified by:

record in interface MarcRecordListener

Overrides:

record in class MarcContentHandler

Parameters:

marcRecord - the record

startCustomElement

public void startCustomElement(java.lang.String prefix,
                               java.lang.String uri,
                               java.lang.String localname)

endCustomElement

public void endCustomElement(java.lang.String prefix,
                             java.lang.String uri,
                             java.lang.String localname)

flush

public void flush()
           throws java.io.IOException

Specified by:

flush in interface java.io.Flushable

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getException

public java.lang.Exception getException()