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

All Known Implementing Classes:

NullReader, ResourceTypeReader

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:

$Revision: 541508 $, $Date: 2007-05-24 21:54:12 -0400 (Thu, 24 May 2007) $

Method Summary

int	getVersion() The second byte of the header contains the version.
InlineMetaMap	read(Value data) 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(Value data)
                   throws InlineMetaException

When a header is read, it generates a Map containing the attributes carried by the header.

Parameters:

data - Value object in which the header is embedded

Returns:

Map containing the attributes read from the header

Throws:

InlineMetaException - if the header data is corrupted or of the wrong length