Xindice API
version 1.1b3

org.apache.xindice.core.meta.inline
Interface InlineMetaReader

All Known Implementing Classes:
ResourceTypeReader, NullReader

public interface InlineMetaReader

The Value associated with a Record can be prefixed by a header containing 'inline' metadata. The original motivation for this extension is to support binary resources in the same filer where the XML documents live.

Version:
CVS $Revision: 1.3 $, $Date: 2003/08/07 20:13:22 $

Method Summary
 int getVersion()
          The second byte of the header contains the version.
 InlineMetaMap read(byte[] data, int offset, int length)
          When a header is read, it generates a Map containing the attributes carried by the header.
 

Method Detail

getVersion

public int getVersion()
The second byte of the header contains the version. The reader which is called to read the header is determined by the version.

read

public InlineMetaMap read(byte[] data,
                          int offset,
                          int length)
                   throws InlineMetaException
When a header is read, it generates a Map containing the attributes carried by the header.
Parameters:
data - array in which the header is embedded
offset - from the beginning of the data array to the beginning of the header.
length - of the header data
Returns:
Map containing the attributes read from the header
Throws:
InlineMetaException - if the header data is corrupted or of the wrong length

Xindice API
version 1.1b3

Copyright (c) 1999-2003 The Apache Software Foundation. All Rights Reserved.