gate.mimir.index

Class OriginalMarkupMetadataHelper

java.lang.Object

gate.mimir.index.OriginalMarkupMetadataHelper

All Implemented Interfaces:

DocumentMetadataHelper, DocumentRenderer

public class OriginalMarkupMetadataHelper
extends Object
implements DocumentMetadataHelper, DocumentRenderer

An implementation of DocumentMetadataHelper and DocumentRenderer that imports relevant markup tags from the indexed document's original markups annotation set, saves them as document metadata in the zip collection, and then uses these saved values to render the document at search time. The metadata saved by this class is stored in the main document metadata map using this class's name as a key. The value save is itself a Map, with multiple metadata fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	OriginalMarkupMetadataHelper.DocumentTags An object storing a list of tags (obtained from the original markup) that should be saved as document metadata.
protected static class	OriginalMarkupMetadataHelper.StartComparator Compares annotation by start offset, end offset, and ID.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_TAG_TYPES The names of the original tags that should be preserved as document metadata in the zip collection, and used for rendering documents.
static String	HIT_CLOSING_TAG The tag used to mark-up query hits (closing tag).
static String	HIT_OPENING_TAG The tag used to mark-up query hits (opening tag).
static String	TAGS_KEY

Constructor Summary

Constructors

Constructor and Description
OriginalMarkupMetadataHelper(Set<String> markupAnnTypes) Creates a new document helper/renderer.

Method Summary

Modifier and Type	Method and Description
protected void	addMetadataField(DocumentData documentData, String key, Serializable value) Adds a new field to the metadata map saved by this class.
void	documentEnd(GATEDocument document, DocumentData documentData) Called when the indexing of a document has completed.
void	documentStart(GATEDocument document) Called when the indexing a new document begins.
protected static String	getClosingTag(String openingTag) Calculates the closing tag for a given opening tag.
protected Serializable	getMetadataField(DocumentData documentData, String key) Gets a metadata field value from the metadata map saved by this class.
protected int	getTagId(gate.Annotation ann, OriginalMarkupMetadataHelper.DocumentTags documentMetadata) Gets the ID in the current list of tag descriptors for a given annotation
void	render(DocumentData documentData, List<Binding> hits, Appendable output) Renders a document, using the saved original markup tags, and adding tags for the provided query hits.
protected String	tagNameForAnnotation(gate.Annotation ann) Returns the tag name that should be used to represent the given annotation.

Methods inherited from class java.lang.Object

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

Field Detail

TAGS_KEY

public static final String TAGS_KEY

See Also:

Constant Field Values

DEFAULT_TAG_TYPES

public static final String[] DEFAULT_TAG_TYPES

The names of the original tags that should be preserved as document metadata in the zip collection, and used for rendering documents.

HIT_OPENING_TAG

public static final String HIT_OPENING_TAG

The tag used to mark-up query hits (opening tag).

See Also:

Constant Field Values

HIT_CLOSING_TAG

public static final String HIT_CLOSING_TAG

The tag used to mark-up query hits (closing tag).

See Also:

Constant Field Values

Constructor Detail

OriginalMarkupMetadataHelper

public OriginalMarkupMetadataHelper(Set<String> markupAnnTypes)

Creates a new document helper/renderer.

Parameters:

markupAnnTypes - the types of annotations from the original markups set that should be saved as document metadata (and used for rendering documents). If the value given for this parameter is null, then the default set of tags is used (see DEFAULT_TAG_TYPES).

Method Detail

render

public void render(DocumentData documentData,
                   List<Binding> hits,
                   Appendable output)
            throws IOException

Renders a document, using the saved original markup tags, and adding tags for the provided query hits. This will generate HTML (XML, XHTML, etc) content by printing out the document tokens, spaces, and tags.

Specified by:

render in interface DocumentRenderer

Parameters:

documentData - the DocumentData object for the document to be rendered.

hits - the list of hits that need to also be rendered.

output - a Appendable to which the output is written.

Throws:

IOException

See Also:

DocumentRenderer.render(gate.mimir.index.DocumentData, java.util.List, java.lang.Appendable)

documentEnd

public void documentEnd(GATEDocument document,
                        DocumentData documentData)

Description copied from interface: DocumentMetadataHelper

Called when the indexing of a document has completed. This method should add metadata fields to the provided documentData object.

Specified by:

documentEnd in interface DocumentMetadataHelper

Parameters:

document - the document being indexed

documentData - the documentData value that will be stored as part of the index, and which holds the metadata fields.

addMetadataField

protected void addMetadataField(DocumentData documentData,
                                String key,
                                Serializable value)

Adds a new field to the metadata map saved by this class.

Parameters:

key -

value -

getMetadataField

protected Serializable getMetadataField(DocumentData documentData,
                                        String key)

Gets a metadata field value from the metadata map saved by this class.

Parameters:

key -

value -

getClosingTag

protected static String getClosingTag(String openingTag)

Calculates the closing tag for a given opening tag.

Parameters:

openingTag -

Returns:

getTagId

protected int getTagId(gate.Annotation ann,
                       OriginalMarkupMetadataHelper.DocumentTags documentMetadata)

Gets the ID in the current list of tag descriptors for a given annotation

Parameters:

ann -

Returns:

tagNameForAnnotation

protected String tagNameForAnnotation(gate.Annotation ann)

Returns the tag name that should be used to represent the given annotation. This implementation simply returns the (trimmed) annotation type, but subclasses may implement a more sophisticated mapping.

Parameters:

ann - an annotation

Returns:

the tag name that should be used to represent the annotation

documentStart

public void documentStart(GATEDocument document)

Description copied from interface: DocumentMetadataHelper

Called when the indexing a new document begins.

Specified by:

documentStart in interface DocumentMetadataHelper

Parameters:

document - the document being indexed.