com.ximpleware.extended

Class XMLMemMappedBuffer

java.lang.Object

com.ximpleware.extended.XMLMemMappedBuffer

All Implemented Interfaces:

com.ximpleware.extended.IByteBuffer

public class XMLMemMappedBuffer
extends java.lang.Object
implements com.ximpleware.extended.IByteBuffer

XMLMemMappedBuffer maps an XML document into memory using memory map. It avoids the complete loading of the document in memory thus making it possible to process very large files. But the trade off is potentially lower performance due to disk IO.

Constructor Summary

Constructors

Constructor and Description
XMLMemMappedBuffer()

Method Summary

Modifier and Type	Method and Description
byte	byteAt(long index) Get the byte at the given index of the underlying byte storage.
void	close() If teh underlying byte representation is IO related, close the IO stream
byte[]	getBytes() NOt implemented yet
byte[]	getBytes(int offset, int len) not implemented yet
long	length() Total size in terms of # of bytes.
void	readFile(java.lang.String fileName)
void	writeToFileOutputStream(java.io.FileOutputStream ost, long os, long len) write the segment (denoted by its offset and length) into an output file stream

Methods inherited from class java.lang.Object

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

Constructor Detail

XMLMemMappedBuffer

public XMLMemMappedBuffer()

Method Detail

byteAt

public byte byteAt(long index)

Description copied from interface: com.ximpleware.extended.IByteBuffer

Get the byte at the given index of the underlying byte storage.

Specified by:

byteAt in interface com.ximpleware.extended.IByteBuffer

Returns:

byte

close

public void close()

Description copied from interface: com.ximpleware.extended.IByteBuffer

If teh underlying byte representation is IO related, close the IO stream

Specified by:

close in interface com.ximpleware.extended.IByteBuffer

getBytes

public byte[] getBytes()

NOt implemented yet

Specified by:

getBytes in interface com.ximpleware.extended.IByteBuffer

getBytes

public byte[] getBytes(int offset,
                       int len)

not implemented yet

Specified by:

getBytes in interface com.ximpleware.extended.IByteBuffer

Parameters:

offset - int bytes offset (not UTF char unit)

len - int

Returns:

byte[]

length

public long length()

Description copied from interface: com.ximpleware.extended.IByteBuffer

Total size in terms of # of bytes.

Specified by:

length in interface com.ximpleware.extended.IByteBuffer

Returns:

long

readFile

public void readFile(java.lang.String fileName)
              throws java.io.IOException,
                     ParseExceptionHuge

Throws:

java.io.IOException

ParseExceptionHuge

writeToFileOutputStream

public void writeToFileOutputStream(java.io.FileOutputStream ost,
                                    long os,
                                    long len)
                             throws java.io.IOException

write the segment (denoted by its offset and length) into an output file stream

Specified by:

writeToFileOutputStream in interface com.ximpleware.extended.IByteBuffer

Throws:

java.io.IOException