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

All Known Implementing Classes:

NullWriter, ResourceTypeWriter

public interface InlineMetaWriter

The Value associated with a Record can be prefixed by a header containing 'inline' metadata. This class writes the metadata carried by the header. 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

byte[]	getMetadata(InlineMetaMap map) Create the metadata.
int	getVersion() The header version created by the implementing writer.

Method Detail

getVersion

public int getVersion()

The header version created by the implementing writer.

getMetadata

public byte[] getMetadata(InlineMetaMap map)
                   throws InlineMetaException

Create the metadata. The contents are drawn from the map.

Parameters:

map - from which the metadata is drawn

Throws:

InlineMetaException - if the map is not usable by this writer, or is missing required entries.