com.esri.gpt.catalog.lucene
Class SchemaFilter

java.lang.Object
  org.apache.lucene.search.Filter
      com.esri.gpt.catalog.lucene.SchemaFilter

All Implemented Interfaces:

Serializable

public class SchemaFilter
extends Filter

A filter that limits the response to a specific schema name.

e.g. http://www.isotc211.org/2005/gmd

See Also:

Serialized Form

Constructor Summary

SchemaFilter(String schemaName, Filter chained)
Constructs with an associated schema name.

Method Summary

DocIdSet	getDocIdSet(IndexReader reader) Applies the filter and returns a DocIdSet of matching documents.
long	getTimeMillis() Gets the execution time.
protected void	setTimeMillis(long millis) Sets the execution time.

Methods inherited from class java.lang.Object

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

Constructor Detail

SchemaFilter

public SchemaFilter(String schemaName,
                    Filter chained)

Constructs with an associated schema name.

Parameters:

schemaName - the schema name

chained - a chained filter

Method Detail

getTimeMillis

public long getTimeMillis()

Gets the execution time.

Returns:

the execution time (in milliseconds)

setTimeMillis

protected void setTimeMillis(long millis)

Sets the execution time.

Parameters:

millis - the execution time (in milliseconds)

getDocIdSet

public DocIdSet getDocIdSet(IndexReader reader)
                     throws IOException

Applies the filter and returns a DocIdSet of matching documents.

Specified by:

getDocIdSet in class Filter

Parameters:

reader - the index reader

Returns:

the DocIdSet (documents that are visible to the supplied user principals)

Throws:

IOException - if an exception is encountered while reading the index