be.re.repo
Interface XMLTextExtract

public interface XMLTextExtract

The interface for external modules to extract the text from an XML document. Such modules are declared in /configuration/maps.xml using the text-extract element as in the following example:

 <text-extract>
   <mime-type>text/xml</mime-type>
   <mime-type>application/xml</mime-type>
   <mime-type>* /*+xml</mime-type>
   <class><name>be.re.repo.mod.TextExtractXML</name></class>
 </text-extract>
 
 

Author:

Werner Donné

Method Summary

Reader

get(String vcr, String version, XMLEventReader in, String mimeType, Context context) The method should return the complete text from the document.

Method Detail

get

Reader get(String vcr,
           String version,
           XMLEventReader in,
           String mimeType,
           Context context)
           throws IOException,
                  XMLStreamException

The method should return the complete text from the document.

Parameters:

vcr - the local path of the resource.

version - the version path of the resource.

in - the XML-stream for the document.

mimeType - the MIME type of the document.

context - the repository context.

Returns:

The stream of extracted characters.

Throws:

IOException

XMLStreamException