Marc (marc 1.0.9 API)

java.lang.Object
- org.xbib.marc.Marc

```
public final class Marc
extends java.lang.Object
```
A MARC instance for top-level fluent API style access to the most viable methods of parsing, converting, transforming ISO 2709 and XML input streams.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Marc.Builder` A builder for MARC field streams, MARC records, and XML.
`static class`	`Marc.MarcIso2709Reader` Read from a ISO 2709 stream and emit SAX events.
`static class`	`Marc.MarcXmlReader` A XML reader for MARC XML.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AlephSequentialInputStream`	`aleph()` Return an ALEPH SEQUENTIAL input stream with line-feed separator.
`BiblioMondoInputStream`	`bibliomondo()` Return a BiblioMonod MARC export input stream.
`static Marc.Builder`	`builder()` Create a new MARC builder.
`org.w3c.dom.Document`	`document()` Return a W3C DOM of the record in the ISO 2709 input stream.
`BufferedSeparatorInputStream`	`iso2709Stream()` Return ISO 2709 stream.
`Marc.MarcIso2709Reader`	`iso2709XmlReader()` Return an XML reader on a ISO 2709 input stream.
`MabDisketteInputStream`	`mabDisketteCRLF()` Return a MAB DISKETTE input stream with carriage-return/line-feed spearator.
`MabDisketteInputStream`	`mabDisketteLF()` Return a MAB DISKETTE input stream with line-feed spearator.
`MabDisketteInputStream`	`mabDiskettePlusSubfieldsCRLF(char subfieldDelimiter)` Return a MAB DISKETTE input stream with carriage-return/line-feed spearator and subfields.
`void`	`parseEvents(MarcXchangeEventConsumer consumer)` Run XML stream parser over an XML input stream, with an XML event consumer.
`PicaInputStream`	`pica()` Return a Pica input stream with line-feed separator.
`PicaPlainInputStream`	`picaPlain()` Return a Pica Plain input stream with line-feed separator.
`SisisInputStream`	`sisis()` Return a SISIS input stream with line-feed spearator.
`SisisInputStream`	`sisisCRLF()` Return a SISIS input stream with carriage-return/line-feed spearator.
`void`	`transform(javax.xml.transform.TransformerFactory factory, java.net.URL stylesheetUrl, javax.xml.transform.Result result)` Transform W3C document of the record in the ISO 2709 input stream by an XSL stylesheet.
`void`	`transform(java.net.URL stylesheetUrl, javax.xml.transform.Result result)` Transform W3C document of the record in the ISO 2709 input stream by an XSL stylesheet.
`int`	`wrapFields(ChunkStream<byte[],BytesReference> stream, boolean withCollection)` Pass a given chunk stream to a MARC generator, chunk by chunk.
`int`	`wrapIntoCollection(ChunkStream<byte[],BytesReference> stream)`
`long`	`wrapRecords(ChunkStream<byte[],BytesReference> stream, boolean withCollection)` Wrap records into a collection.
`void`	`writeCollection()` Write MARC bibliographic data from seperator stream chunk by chunk to a MARC collection.
`void`	`writeRecordCollection()` Write MARC bibliographic events from a separator strem, record by record, wrapped into a pair of `collection` elements.
`void`	`writeRecords()` Write MARC bibliographic events from a separator strem, record by record.
`Marc.MarcXmlReader`	`xmlReader()` Return an XML reader on an XML input stream.

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

- Method Detail
  - builder
```
public static Marc.Builder builder()
```
    Create a new MARC builder.
    
    Returns:
    
    a new MARC builder
  - iso2709XmlReader
```
public Marc.MarcIso2709Reader iso2709XmlReader()
```
    Return an XML reader on a ISO 2709 input stream.
    
    Returns:
    
    XML reader
  - xmlReader
```
public Marc.MarcXmlReader xmlReader()
```
    Return an XML reader on an XML input stream.
    
    Returns:
    
    XML reader
  - parseEvents
```
public void parseEvents(MarcXchangeEventConsumer consumer)
                 throws javax.xml.stream.XMLStreamException
```
    Run XML stream parser over an XML input stream, with an XML event consumer.
    
    Parameters:
    
    consumer - the XML event consumer
    
    Throws:
    
    javax.xml.stream.XMLStreamException - if parsing fails
  - iso2709Stream
```
public BufferedSeparatorInputStream iso2709Stream()
```
    Return ISO 2709 stream.
    
    Returns:
    
    ISO 2709 stream
  - mabDisketteCRLF
```
public MabDisketteInputStream mabDisketteCRLF()
```
    Return a MAB DISKETTE input stream with carriage-return/line-feed spearator.
    
    Returns:
    
    the MAB DISKETTE input stream
  - mabDisketteLF
```
public MabDisketteInputStream mabDisketteLF()
```
    Return a MAB DISKETTE input stream with line-feed spearator.
    
    Returns:
    
    the MAB DISKETTE input stream
  - mabDiskettePlusSubfieldsCRLF
```
public MabDisketteInputStream mabDiskettePlusSubfieldsCRLF(char subfieldDelimiter)
```
    Return a MAB DISKETTE input stream with carriage-return/line-feed spearator and subfields.
    
    Parameters:
    
    subfieldDelimiter - subfield delimiter
    
    Returns:
    
    the MAB DISKETTE input stream
  - sisis
```
public SisisInputStream sisis()
```
    Return a SISIS input stream with line-feed spearator.
    
    Returns:
    
    the SISIS input stream
  - sisisCRLF
```
public SisisInputStream sisisCRLF()
```
    Return a SISIS input stream with carriage-return/line-feed spearator.
    
    Returns:
    
    the SISIS input stream
  - aleph
```
public AlephSequentialInputStream aleph()
```
    Return an ALEPH SEQUENTIAL input stream with line-feed separator.
    
    Returns:
    
    an ALEPH SEQUENTIAL input stream
  - pica
```
public PicaInputStream pica()
```
    Return a Pica input stream with line-feed separator.
    
    Returns:
    
    Pica input stream
  - picaPlain
```
public PicaPlainInputStream picaPlain()
```
    Return a Pica Plain input stream with line-feed separator.
    
    Returns:
    
    Pica Plain input stream
  - bibliomondo
```
public BiblioMondoInputStream bibliomondo()
```
    Return a BiblioMonod MARC export input stream. Default is carriage-return/line-feed spearator.
    
    Returns:
    
    a BiblioMonod MARC export input stream
  - document
```
public org.w3c.dom.Document document()
                              throws java.io.IOException
```
    Return a W3C DOM of the record in the ISO 2709 input stream.
    
    Returns:
    
    W3C DOM
    
    Throws:
    
    java.io.IOException - if parsing fails
  - transform
```
public void transform(java.net.URL stylesheetUrl,
                      javax.xml.transform.Result result)
               throws java.io.IOException
```
    Transform W3C document of the record in the ISO 2709 input stream by an XSL stylesheet.
    
    Parameters:
    
    stylesheetUrl - the URL of the stylesheet
    
    result - the result of the transformation
    
    Throws:
    
    java.io.IOException - if transformation fails
  - transform
```
public void transform(javax.xml.transform.TransformerFactory factory,
                      java.net.URL stylesheetUrl,
                      javax.xml.transform.Result result)
               throws java.io.IOException
```
    Transform W3C document of the record in the ISO 2709 input stream by an XSL stylesheet.
    
    Parameters:
    
    factory - the transformer factory
    
    stylesheetUrl - the URL of the stylesheet
    
    result - the result of the transformation
    
    Throws:
    
    java.io.IOException - if transformation fails
  - writeCollection
```
public void writeCollection()
                     throws java.io.IOException
```
    Write MARC bibliographic data from seperator stream chunk by chunk to a MARC collection.
    
    Throws:
    
    java.io.IOException - if writing fails
  - wrapIntoCollection
```
public int wrapIntoCollection(ChunkStream<byte[],BytesReference> stream)
                       throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - wrapFields
```
public int wrapFields(ChunkStream<byte[],BytesReference> stream,
                      boolean withCollection)
               throws java.io.IOException
```
    Pass a given chunk stream to a MARC generator, chunk by chunk. Can process any MARC streams, not only separator streams.
    
    Parameters:
    
    stream - a chunk stream
    
    withCollection - true if stream should be wrapped into a collection element
    
    Returns:
    
    the number of chunks in the stream
    
    Throws:
    
    java.io.IOException - if chunk reading fails
  - writeRecordCollection
```
public void writeRecordCollection()
                           throws java.io.IOException
```
    Write MARC bibliographic events from a separator strem, record by record, wrapped into a pair of collection elements.
    
    Throws:
    
    java.io.IOException - if writing fails
  - writeRecords
```
public void writeRecords()
                  throws java.io.IOException
```
    Write MARC bibliographic events from a separator strem, record by record.
    
    Throws:
    
    java.io.IOException - if writing fails
  - wrapRecords
```
public long wrapRecords(ChunkStream<byte[],BytesReference> stream,
                        boolean withCollection)
                 throws java.io.IOException
```
    Wrap records into a collection. Can process any MARC streams, not only separator streams.
    
    Parameters:
    
    stream - a chunk stream
    
    withCollection - true if collection elements should be used, false if not
    
    Returns:
    
    the number of chunks in the stream
    
    Throws:
    
    java.io.IOException - if chunk reading fails

Class Marc

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

builder

iso2709XmlReader

xmlReader

parseEvents

iso2709Stream

mabDisketteCRLF

mabDisketteLF

mabDiskettePlusSubfieldsCRLF

sisis

sisisCRLF

aleph

pica

picaPlain

bibliomondo

document

transform

transform

writeCollection

wrapIntoCollection

wrapFields

writeRecordCollection

writeRecords

wrapRecords