com.xerox.bantam.util
Class AbstractQueryFactory

java.lang.Object
  |
  +--com.xerox.bantam.util.AbstractQueryFactory

All Implemented Interfaces:

QueryFactory

public abstract class AbstractQueryFactory

extends Object

implements QueryFactory

This is a base class for working up a query factory. It has some basic functionality, but also implements QueryFactory, forcing all of its subclasses to implement that.

Version:

$Revision: 1.8 $, $Date: 2000/11/30 06:10:34 $

Author:

Tom Rodriguez

Constructor Summary

AbstractQueryFactory()

Method Summary

Query	create(String query) Placeholder for queries expressed as a String in an external query language.
Query	propertyContains(FieldDescriptor name, Object value)
Query	propertyContainsText(FieldDescriptor name, String substr)
Query	propertyContainsTextIgnoreCase(FieldDescriptor name, String substr)
Query	propertyEquals(FieldDescriptor name, Object value)
Query	propertyEquals(FieldDescriptor name, String value)
Query	propertyEqualsIgnoreCase(FieldDescriptor name, String value)
Query	propertyExists(FieldDescriptor name) Matches documents having a value for the specified property name.
Query	propertyGreaterThan(FieldDescriptor name, Comparable value)
Query	propertyGreaterThanEquals(FieldDescriptor name, Comparable value)
Query	propertyLessThan(FieldDescriptor name, Comparable value)
Query	propertyLessThanEquals(FieldDescriptor name, Comparable value)
Query	propertyNotEquals(FieldDescriptor name, Object value)
Query	propertyNotEquals(FieldDescriptor name, String value)
Query	textContains(String value) Matches documents having the specified value as a substring of a text extraction of the content.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.xerox.bantam.QueryFactory

all, and, conformsTo, isEnforced, not, or, propertyContains, propertyContainsText, propertyContainsTextIgnoreCase, propertyEquals, propertyEquals, propertyEqualsIgnoreCase, propertyExists, propertyGreaterThan, propertyGreaterThanEquals, propertyLessThan, propertyLessThanEquals, propertyNotEquals, propertyNotEquals

Constructor Detail

AbstractQueryFactory

public AbstractQueryFactory()

Method Detail

create

public Query create(String query)
             throws StorageException

Description copied from interface: QueryFactory

Placeholder for queries expressed as a String in an external query language. There is no Bantam standard query language yet and this method will throw a runtime exception on most implementations. Do not rely upon this method or the format of any query expression that happens to work on a particular implementation. @deprecated As of Angstrom/Harland this method is unsupported.

Specified by:

create in interface QueryFactory

propertyExists

public Query propertyExists(FieldDescriptor name)
                     throws StorageException

Description copied from interface: QueryFactory

Matches documents having a value for the specified property name.

Specified by:

propertyExists in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyExists(String)

propertyEquals

public Query propertyEquals(FieldDescriptor name,
                            Object value)
                     throws StorageException

Specified by:

propertyEquals in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyEquals(String, Object)

propertyEquals

public Query propertyEquals(FieldDescriptor name,
                            String value)
                     throws StorageException

Specified by:

propertyEquals in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyEquals(String, Object)

propertyNotEquals

public Query propertyNotEquals(FieldDescriptor name,
                               Object value)
                        throws StorageException

Specified by:

propertyNotEquals in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyNotEquals(String, Object)

propertyNotEquals

public Query propertyNotEquals(FieldDescriptor name,
                               String value)
                        throws StorageException

Specified by:

propertyNotEquals in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyNotEquals(String, Object)

propertyLessThan

public Query propertyLessThan(FieldDescriptor name,
                              Comparable value)
                       throws StorageException

Specified by:

propertyLessThan in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyLessThan(String, Comparable)

propertyLessThanEquals

public Query propertyLessThanEquals(FieldDescriptor name,
                                    Comparable value)
                             throws StorageException

Specified by:

propertyLessThanEquals in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyLessThanEquals(String, Comparable)

propertyGreaterThan

public Query propertyGreaterThan(FieldDescriptor name,
                                 Comparable value)
                          throws StorageException

Specified by:

propertyGreaterThan in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyGreaterThan(String, Comparable)

propertyGreaterThanEquals

public Query propertyGreaterThanEquals(FieldDescriptor name,
                                       Comparable value)
                                throws StorageException

Specified by:

propertyGreaterThanEquals in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyGreaterThanEquals(String, Comparable)

propertyEqualsIgnoreCase

public Query propertyEqualsIgnoreCase(FieldDescriptor name,
                                      String value)
                               throws StorageException

Specified by:

propertyEqualsIgnoreCase in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyEqualsIgnoreCase(String, String)

propertyContainsText

public Query propertyContainsText(FieldDescriptor name,
                                  String substr)
                           throws StorageException

Specified by:

propertyContainsText in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyContainsText(String, String)

propertyContainsTextIgnoreCase

public Query propertyContainsTextIgnoreCase(FieldDescriptor name,
                                            String substr)
                                     throws StorageException

Specified by:

propertyContainsTextIgnoreCase in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyContainsTextIgnoreCase(String, String)

propertyContains

public Query propertyContains(FieldDescriptor name,
                              Object value)
                       throws StorageException

Specified by:

propertyContains in interface QueryFactory

Following copied from interface: com.xerox.bantam.QueryFactory

See Also:

QueryFactory.propertyContains(String, Object)

textContains

public Query textContains(String value)
                   throws StorageException

Description copied from interface: QueryFactory

Matches documents having the specified value as a substring of a text extraction of the content. It follows that this predicate matches only Bantam ContentDocuments. The algorithm by which text is extracted from various content types is implementation-specific. Implementation-specific query syntax may also be accepted within value.

Specified by:

textContains in interface QueryFactory