org.opensolaris.opengrok.search.context

Class HistoryContext

java.lang.Object

org.opensolaris.opengrok.search.context.HistoryContext

public class HistoryContext
extends java.lang.Object

it is supposed to get the matching lines from history log files. since lucene does not easily give the match context.

Constructor Summary

Constructors

Constructor and Description
HistoryContext(org.apache.lucene.search.Query query)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getContext(java.io.File src, java.lang.String path, java.io.Writer out, java.lang.String context) Obtain the history for the source file src and write out matching History log entries.
boolean	getContext(java.lang.String filename, java.lang.String path, java.util.List<Hit> hits)
boolean	getContext(java.lang.String parent, java.lang.String basename, java.lang.String path, java.io.Writer out, java.lang.String context)
boolean	isEmpty()

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryContext

public HistoryContext(org.apache.lucene.search.Query query)

Method Detail

isEmpty

public boolean isEmpty()

getContext

public boolean getContext(java.lang.String filename,
                 java.lang.String path,
                 java.util.List<Hit> hits)
                   throws HistoryException

Throws:

HistoryException

getContext

public boolean getContext(java.lang.String parent,
                 java.lang.String basename,
                 java.lang.String path,
                 java.io.Writer out,
                 java.lang.String context)
                   throws HistoryException

Throws:

HistoryException

getContext

public boolean getContext(java.io.File src,
                 java.lang.String path,
                 java.io.Writer out,
                 java.lang.String context)
                   throws HistoryException

Obtain the history for the source file src and write out matching History log entries.

Parameters:

src - the source file represented by path (SOURCE_ROOT + path)

path - the path of the file (rooted at SOURCE_ROOT)

out - write destination

context - the servlet context path of the application (the path prefix for URLs)

Returns:

true if at least one line has been written out.

Throws:

HistoryException