A B C D E F G H I L M N O P Q R S T U V W

A

AbstractBackedObject - class com.xerox.bantam.util.AbstractBackedObject.

A basic implementation of BackedObject.

AbstractBackedObject(Document) - Constructor for class com.xerox.bantam.util.AbstractBackedObject

AbstractDocument - class com.xerox.bantam.util.AbstractDocument.

This is a base class for working up a Document.

AbstractDocument() - Constructor for class com.xerox.bantam.util.AbstractDocument

AbstractQueryFactory - class com.xerox.bantam.util.AbstractQueryFactory.

This is a base class for working up a query factory.

AbstractQueryFactory() - Constructor for class com.xerox.bantam.util.AbstractQueryFactory

AbstractStorage - class com.xerox.bantam.util.AbstractStorage.

This is a base class for working up a storage.

AbstractStorage() - Constructor for class com.xerox.bantam.util.AbstractStorage

add(int, Object) - Method in class com.xerox.bantam.util.DocumentListImpl

add(Object) - Method in interface com.xerox.bantam.CollectionDocument

Set method for explicitly adding documents with the same semantics as addDocument.

add(Object) - Method in class com.xerox.bantam.util.DocumentListImpl

add(Schema) - Method in class com.xerox.bantam.util.SchemaMap

addAll(Collection) - Method in interface com.xerox.bantam.CollectionDocument

Set method for explicitly adding a number of documents with the same net effect as invoking addDocument on each individually.

addAll(Collection) - Method in class com.xerox.bantam.util.DocumentListImpl

addDocument(Document) - Method in interface com.xerox.bantam.CollectionDocument

Add the specified document.

addDocument(Document) - Method in interface com.xerox.bantam.DocumentList

Appends the specified document to the end of the list

addDocument(Document) - Method in class com.xerox.bantam.util.DocumentListImpl

addDocument(int, Document) - Method in interface com.xerox.bantam.DocumentList

Inserts the specified document at the specified position

addDocument(int, Document) - Method in class com.xerox.bantam.util.DocumentListImpl

addDocument(String) - Method in interface com.xerox.bantam.CollectionDocument

Version of addDocument that takes an ID rather than a Document object.

addDocuments(DocumentList) - Method in interface com.xerox.bantam.DocumentList

Appends all of the documents in the supplied list to the end of this list, in their original order.

addDocuments(DocumentList) - Method in class com.xerox.bantam.util.DocumentListImpl

addMultiValue(FieldDescriptor, Serializable) - Method in interface com.xerox.bantam.Document

Adds property value by field descriptor.

addMultiValue(String, Serializable) - Method in interface com.xerox.bantam.Document

Adds property value.

addPersistentSchema(Schema) - Method in class com.xerox.bantam.util.AbstractDocument

Add a schema to the persistent schema record.

addQueryListener(Query, QueryListener) - Method in class com.xerox.bantam.util.AbstractStorage

Add a query listener to a given storage, listening for a change in the results of query q.

addSchema(Schema) - Method in class com.xerox.bantam.util.AbstractDocument

Add a schema.

addToMap(Map, Object, Document) - Static method in class com.xerox.bantam.util.AbstractStorage

Used by the map creation routines.

addValue(Object) - Method in class com.xerox.bantam.EnumeratedType

ALL - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

all() - Method in interface com.xerox.bantam.QueryFactory

Matches all documents.

AND - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

and(Query, Query) - Method in interface com.xerox.bantam.QueryFactory

Boolean conjunction of two sub-queries: matches documents matched by both the right and left sub-queries.

B

BackedObject - interface com.xerox.bantam.util.BackedObject.

This is a simple interface that objects backed by documents may want to implement.

BAD_CLASSNAME - Static variable in class com.xerox.bantam.StorageException

User supplied a class name (in a schema) that could not be found.

BAD_DOCUMENT - Static variable in class com.xerox.bantam.StorageException

The Document (or document identifier) passed into Bantam as an argument could not be found.

C

checkpoint() - Method in class com.xerox.bantam.util.AbstractBackedObject

checkpoint() - Method in interface com.xerox.bantam.util.BackedObject

ClassTypeDescriptor - class com.xerox.bantam.ClassTypeDescriptor.

TypeDescriptor for value types identical to Java classes.

ClassTypeDescriptor() - Constructor for class com.xerox.bantam.ClassTypeDescriptor

ClassTypeDescriptor(Class) - Constructor for class com.xerox.bantam.ClassTypeDescriptor

clazz - Variable in class com.xerox.bantam.ClassTypeDescriptor

The class which is this type.

clear() - Method in interface com.xerox.bantam.CollectionDocument

Clear collection membership.

clearProperty(FieldDescriptor) - Method in interface com.xerox.bantam.Document

Remove any and all values of a property by field descriptor.

clearProperty(FieldDescriptor) - Method in class com.xerox.bantam.util.AbstractDocument

Remove all values of a property

clearProperty(String) - Method in interface com.xerox.bantam.Document

Remove any and all values of a property.

clearQuery() - Method in interface com.xerox.bantam.CollectionDocument

Clear the query associated with the collection.

COLLECTION - Static variable in class com.xerox.bantam.DocumentType

CollectionDocument - interface com.xerox.bantam.CollectionDocument.

An interface for a Document containing other documents.

com.xerox.bantam - package com.xerox.bantam

Bantam is an interface to a store of propertied documents with schema enforcement.

com.xerox.bantam.util - package com.xerox.bantam.util

The Util subpackage collects a variety of helpful pieces of implementation, primarily of value to those producing Storage implementations.

COMBINED - Static variable in class com.xerox.bantam.DocumentType

Note that COMBINED is provided for future expansion and may not be supported by any particular implementation.

compare(Object, Object) - Method in class com.xerox.bantam.Schema.fieldCompare

conformsTo(Schema) - Method in interface com.xerox.bantam.Document

Determine whether the document conforms to the specified schema.

conformsTo(Schema) - Method in interface com.xerox.bantam.QueryFactory

Matches documents that conform to the named schema, that is, documents whose set of property values meets the requirements of the schema.

contains(Object) - Method in interface com.xerox.bantam.CollectionDocument

Set method for testing for presence of a particular document.

contains(Object) - Method in interface com.xerox.bantam.TypeDescriptor

return true if the item is in the type

contains(Object) - Method in class com.xerox.bantam.ClassTypeDescriptor

return true if the item is in the type

contains(Object) - Method in class com.xerox.bantam.EnumeratedType

contains(Object) - Method in class com.xerox.bantam.util.DocumentListImpl

contains(Schema) - Method in class com.xerox.bantam.util.SchemaMap

containsAll(Collection) - Method in interface com.xerox.bantam.CollectionDocument

Set method for testing for presence of particular documents.

containsDocument(Document) - Method in interface com.xerox.bantam.CollectionDocument

Returns true if the collection contains the specified document.

containsDocument(Document) - Method in interface com.xerox.bantam.DocumentList

Returns true if the list contains the specified document

containsDocument(Document) - Method in class com.xerox.bantam.util.DocumentListImpl

containsDocument(String) - Method in interface com.xerox.bantam.CollectionDocument

Returns true if the collection contains the document specified by its ID.

containsProperty(String) - Method in class com.xerox.bantam.util.SchemaMap

containsValue(FieldDescriptor, Serializable) - Method in interface com.xerox.bantam.Document

Determines whether specified value is one of the values of the property

containsValue(FieldDescriptor, Serializable) - Method in class com.xerox.bantam.util.AbstractDocument

Test for existance of a value

containsValue(String, Serializable) - Method in interface com.xerox.bantam.Document

Determines whether specified value is one of the values of the property

CONTENT - Static variable in class com.xerox.bantam.DocumentType

ContentDocument - interface com.xerox.bantam.ContentDocument.

An interface for a Document with associated content.

countDocuments(Query) - Method in interface com.xerox.bantam.Storage

Find the number of documents that match a query.

countDocuments(Query) - Method in class com.xerox.bantam.util.AbstractStorage

Count how many documents match a given query.

create(String) - Method in interface com.xerox.bantam.QueryFactory

Placeholder for queries expressed as a String in an external query language.

create(String) - Method in class com.xerox.bantam.util.AbstractQueryFactory

createDocument(DocumentType) - Method in interface com.xerox.bantam.Storage

Create a document.

createDocument(DocumentType) - Method in class com.xerox.bantam.util.AbstractStorage

This factory method is for creating documents from scratch.

createDocument(DocumentType, Schema, Map) - Method in interface com.xerox.bantam.Storage

Create a document with a particular schema enforced.

createDocument(DocumentType, Schema, Map) - Method in class com.xerox.bantam.util.AbstractStorage

This factory method is for creating documents from scratch.

D

delete() - Method in interface com.xerox.bantam.Document

Delete the document.

deleteAll() - Method in class com.xerox.bantam.util.DocumentListImpl

description() - Method in interface com.xerox.bantam.TypeDescriptor

return a string describing the possible values, suitable for an error message or other guidance to the user

description() - Method in class com.xerox.bantam.ClassTypeDescriptor

return a string describing the possible values, suitable for an error message or other guidance to the user

description() - Method in class com.xerox.bantam.EnumeratedType

DIGIT - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

doc - Variable in class com.xerox.bantam.util.AbstractBackedObject

The document that contains the state for this object

Document - interface com.xerox.bantam.Document.

Root Document interface.

documentExists(String) - Method in interface com.xerox.bantam.Storage

Determine whether the named document exists.

documentExists(String) - Method in class com.xerox.bantam.util.AbstractStorage

Determine whether the document named by 'id' exists.

DocumentList - interface com.xerox.bantam.DocumentList.

A Document container (like java.util.List, with the addition of strongly typed methods).

DocumentListImpl - class com.xerox.bantam.util.DocumentListImpl.

An internal Document container (like ArrayList, only with some strong typing).

DocumentListImpl() - Constructor for class com.xerox.bantam.util.DocumentListImpl

DocumentListImpl(Collection) - Constructor for class com.xerox.bantam.util.DocumentListImpl

DocumentListImpl(int) - Constructor for class com.xerox.bantam.util.DocumentListImpl

DocumentType - class com.xerox.bantam.DocumentType.

Constants for identifying document type.

DOT - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

dumpDocumentProperties(Document) - Static method in class com.xerox.bantam.util.StorageUtil

dumpDocumentProperties(Document, String) - Static method in class com.xerox.bantam.util.StorageUtil

dumpDocumentProperties(Document, String, PrintStream) - Static method in class com.xerox.bantam.util.StorageUtil

E

enforceSchema(Schema) - Method in interface com.xerox.bantam.Document

Enforce the specified schema on the document.

enforceSchema(Schema, Map) - Method in interface com.xerox.bantam.Document

Enforce the specified schema on the document.

EnumeratedType - class com.xerox.bantam.EnumeratedType.

TypeDescriptor for value types that are particular enumerated subsets of values of a Java class.

EnumeratedType(Class) - Constructor for class com.xerox.bantam.EnumeratedType

EOF - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

EQUALEQUALS - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

EQUALS - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

equals(Object) - Method in interface com.xerox.bantam.CollectionDocument

Should return true IFF the target collection is of the same class, shares the same Storage() object, and represents the same entity in the Storage repository.

equals(Object) - Method in class com.xerox.bantam.ClassTypeDescriptor

equals(Object) - Method in class com.xerox.bantam.FieldDescriptor

equals(Object) - Method in class com.xerox.bantam.Schema

Equality test

equals(Object) - Method in class com.xerox.bantam.util.FieldMapping

EQUALSEQUALS - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

equalsType(FieldDescriptor) - Method in class com.xerox.bantam.FieldDescriptor

Restricted equivalence test that returns true if the supplied descriptor imposes the same value type restriction as this descriptor.

EXCLAMATIONPOINT - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

execute() - Method in class com.xerox.bantam.Query

F

FieldDescriptor - class com.xerox.bantam.FieldDescriptor.

A FieldDescriptor is an immutable representation of a Bantam property constraint.

FieldDescriptor(String, Class) - Constructor for class com.xerox.bantam.FieldDescriptor

Simple form constructor for required fields limited to a single value.

FieldDescriptor(String, Class, boolean) - Constructor for class com.xerox.bantam.FieldDescriptor

Abbreviated constructor for fields limited to a single value but possibly optional.

FieldDescriptor(String, Class, int, boolean) - Constructor for class com.xerox.bantam.FieldDescriptor

Full constructor taking Class object.

FieldDescriptor(String, String[], boolean) - Constructor for class com.xerox.bantam.FieldDescriptor

Abbreviated constructor for enumeration field limited to a single value but possibly optional.

FieldDescriptor(String, String[], int, boolean) - Constructor for class com.xerox.bantam.FieldDescriptor

Full constructor for enumeration field.

FieldMapping - class com.xerox.bantam.util.FieldMapping.

Maintains a mapping from a named class field to the corresponding FieldDescriptor.

FieldMapping(String, Class, FieldDescriptor) - Constructor for class com.xerox.bantam.util.FieldMapping

fieldMappings - Variable in class com.xerox.bantam.util.AbstractBackedObject

The mapping between properties and fields of this object for use by restore and checkpoint.

FilesystemRepo - Static variable in interface com.xerox.bantam.Storage

Standard ID for the local filesystem repository

find(Query) - Method in interface com.xerox.bantam.Storage

Find the documents that match a query.

find(Query) - Method in class com.xerox.bantam.util.AbstractStorage

Find all documents that match a given query.

flush() - Method in interface com.xerox.bantam.Document

Force any recent changes to this document to be written to stable storage immediately.

G

get_all_property_names() - Method in interface com.xerox.bantam.Document

Get names of all set properties, including internal properties.

get_all_property_names() - Method in class com.xerox.bantam.util.AbstractDocument

Get property names including those for internal properties

getBackingDocument() - Method in class com.xerox.bantam.util.AbstractBackedObject

getBackingDocument() - Method in interface com.xerox.bantam.util.BackedObject

getBaseType() - Method in interface com.xerox.bantam.TypeDescriptor

The primitive class with represents this type.

getBaseType() - Method in class com.xerox.bantam.ClassTypeDescriptor

getBaseType() - Method in class com.xerox.bantam.FieldDescriptor

getCanRead() - Method in interface com.xerox.bantam.ContentDocument

Return true if the content can be read.

getCanWrite() - Method in interface com.xerox.bantam.ContentDocument

Return true if the content can be written.

getContentProvider() - Method in interface com.xerox.bantam.ContentDocument

Returns the name of the content provider for this specific document.

getContentType() - Method in interface com.xerox.bantam.ContentDocument

Return the MIME type of the content, in a string like text/plain or image/jpeg.

getDescriptor(String) - Static method in class com.xerox.bantam.FieldDescriptor

Retrieve the canonical instance of a descriptor by name.

getDescriptors(Schema) - Method in interface com.xerox.bantam.Document

Get descriptors of set properties from a schema.

getDescriptors(Schema) - Method in class com.xerox.bantam.util.AbstractDocument

Get descriptors of set properties from a schema.

getDocument(int) - Method in interface com.xerox.bantam.DocumentList

Get the document at a specific position

getDocument(int) - Method in class com.xerox.bantam.util.DocumentListImpl

getDocument(String) - Method in interface com.xerox.bantam.Storage

Return the named document.

getDocument(String) - Method in class com.xerox.bantam.util.AbstractStorage

Get a document, given an ID.

getDocuments() - Method in interface com.xerox.bantam.CollectionDocument

Return all of the documents contained in the collection.

getEnforcedSchemas() - Method in interface com.xerox.bantam.Document

Get all schemas enforced on the document.

getExtension(Class) - Method in interface com.xerox.bantam.Storage

Get an object implementing an extension interface on this storage.

getExtension(Class) - Method in class com.xerox.bantam.util.AbstractStorage

getField() - Method in class com.xerox.bantam.util.FieldMapping

getFieldDescriptor() - Method in class com.xerox.bantam.util.FieldMapping

getFieldDescriptor(String) - Method in class com.xerox.bantam.util.SchemaMap

getFieldMappings(Class) - Static method in class com.xerox.bantam.util.FieldMapping

Get all the FieldMappings from clazz which are used to describe the schema they represent.

getFields() - Method in class com.xerox.bantam.Schema

Return all field definitions in the schema

getID() - Method in interface com.xerox.bantam.Document

Get the document's unique ID.

getInfo() - Method in interface com.xerox.bantam.Storage

Get a description of this storage instance.

getInfo() - Method in class com.xerox.bantam.util.AbstractStorage

getInfo(boolean) - Static method in class com.xerox.bantam.StorageVersion

getInfoString() - Static method in class com.xerox.bantam.StorageVersion

getInputStream() - Method in interface com.xerox.bantam.ContentDocument

Return an InputStream to read the content.

getLastModified() - Method in interface com.xerox.bantam.ContentDocument

Return last modification date for the content.

getLength() - Method in interface com.xerox.bantam.ContentDocument

Return the length of the content in bytes.

getMaxValues() - Method in class com.xerox.bantam.FieldDescriptor

getMultiValues(FieldDescriptor) - Method in interface com.xerox.bantam.Document

Gets the values of a property by field descriptor.

getMultiValues(String) - Method in interface com.xerox.bantam.Document

Gets the values of a property.

getName() - Method in interface com.xerox.bantam.Document

Return a canonical "name" value that can be displayed along with the document.

getName() - Static method in class com.xerox.bantam.StorageVersion

getName() - Method in class com.xerox.bantam.FieldDescriptor

getName() - Method in class com.xerox.bantam.Schema

Return schema name.

getName() - Method in interface com.xerox.bantam.Storage

Get the name of this storage implementation.

getName() - Method in class com.xerox.bantam.util.AbstractStorage

getName() - Method in class com.xerox.bantam.util.FieldMapping

getNameString() - Static method in class com.xerox.bantam.StorageVersion

getOutputStream() - Method in interface com.xerox.bantam.ContentDocument

Return an OutputStream to write the content.

getPropertyNames() - Method in interface com.xerox.bantam.Document

Get names of set properties.

getPropertyNames(String) - Method in interface com.xerox.bantam.Document

Get names of set properties with the supplied property name prefix.

getPropertyNames(String) - Method in class com.xerox.bantam.util.AbstractDocument

Returns all properties with the indicated property name prefix.

getPropertyValue(FieldDescriptor) - Method in interface com.xerox.bantam.Document

Returns the value of a single-valued property by field descriptor.

getPropertyValue(String) - Method in interface com.xerox.bantam.Document

Returns the value of a single-valued property if set, or null otherwise.

getQuery() - Method in interface com.xerox.bantam.CollectionDocument

Returns the query associated with the collection.

getQueryFactory() - Method in interface com.xerox.bantam.Storage

Produce a QueryFactory for this storage implementation.

getReader() - Method in interface com.xerox.bantam.ContentDocument

Return a Reader for the content.

getSchema() - Static method in class com.xerox.bantam.util.SchemaSchema

getSchema(Class) - Static method in class com.xerox.bantam.Schema

Retrieve the canonical instance of a schema by class

getSchema(String) - Static method in class com.xerox.bantam.Schema

Retrieve the canonical instance of a schema by name

getSchema(String) - Method in class com.xerox.bantam.util.SchemaMap

getSchemaFields(Class) - Static method in class com.xerox.bantam.Schema

Get all the FieldDescriptors from clazz which are used to describe the schema they represent.

getSchemas() - Method in class com.xerox.bantam.util.SchemaMap

getSingleton(Storage, String) - Static method in class com.xerox.bantam.util.StorageUtil

getSizeOfDocumentSet(Storage, String) - Static method in class com.xerox.bantam.util.StorageUtil

getStackTrace() - Static method in class com.xerox.bantam.StorageException

Internal helper function to support building-up of exception strings.

getStackTrace(Exception) - Static method in class com.xerox.bantam.StorageException

Internal helper function to support "re"-throwing of exceptions.

getStorage() - Method in interface com.xerox.bantam.Document

Return the storage object associated with this document.

getStorage() - Method in class com.xerox.bantam.Query

getTag() - Method in class com.xerox.bantam.StorageException

getTagString() - Method in class com.xerox.bantam.StorageException

getType() - Method in class com.xerox.bantam.FieldDescriptor

getUnenforcedPropertyNames(String) - Method in interface com.xerox.bantam.Document

Get names of set properties that do not belong to an enforced schema.

getUnenforcedPropertyNames(String) - Method in class com.xerox.bantam.util.AbstractDocument

Get unenforced property names

getValueDistribution(String) - Method in interface com.xerox.bantam.Storage

Find the distribution of values of the specified property.

getValueDistribution(String) - Method in class com.xerox.bantam.util.AbstractStorage

Returns a set of all of the values for the specified property.

getValueDistribution(String, Query) - Method in interface com.xerox.bantam.Storage

Find the distribution of values of the specified property over the set of documents matching the query.

getValueDistribution(String, Query) - Method in class com.xerox.bantam.util.AbstractStorage

Returns a set of all the values for the specified property, but only over the documents matching the specified query.

getValueMap(String) - Method in interface com.xerox.bantam.Storage

Find the documents with the specified property organized by value of that property.

getValueMap(String) - Method in class com.xerox.bantam.util.AbstractStorage

Get a value map that maps values to the documents with those values.

getValueMap(String, Query) - Method in interface com.xerox.bantam.Storage

Find the documents matching the query organized by value of the specified property as for the simple form of getValueMap().

getValueMap(String, Query) - Method in class com.xerox.bantam.util.AbstractStorage

Get a value map that maps values to the documents with those values.

getVersion() - Method in class com.xerox.bantam.FieldDescriptor

Return a version stamp which is a signature value for this descriptor.

getVersion() - Method in class com.xerox.bantam.Schema

Return a version stamp which is a signature value for this schema.

getVersion() - Method in interface com.xerox.bantam.Storage

Get the version of this storage implementation.

getVersion() - Method in class com.xerox.bantam.util.AbstractStorage

getVersion(boolean) - Static method in class com.xerox.bantam.StorageVersion

getVersionString() - Static method in class com.xerox.bantam.StorageVersion

getWriter() - Method in interface com.xerox.bantam.ContentDocument

Return a Writer for the content.

guessContentType(Storage, String) - Static method in class com.xerox.bantam.util.StorageUtil

H

hashCode() - Method in interface com.xerox.bantam.CollectionDocument

Returns an implementation-dependent hash code.

hashCode() - Method in class com.xerox.bantam.ClassTypeDescriptor

hashCode() - Method in class com.xerox.bantam.FieldDescriptor

hashCode() - Method in class com.xerox.bantam.util.FieldMapping

I

ID - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

importDocument(DocumentType, String, Object) - Method in interface com.xerox.bantam.Storage

Import an existing document from an external repository.

importDocument(DocumentType, String, Object) - Method in class com.xerox.bantam.util.AbstractStorage

Import a document from a given repository.

importDocument(DocumentType, String, Object, Schema, Map) - Method in interface com.xerox.bantam.Storage

Import an existing document from an external repository with a particular schema enforced.

importDocument(DocumentType, String, Object, Schema, Map) - Method in class com.xerox.bantam.util.AbstractStorage

Import a document from a given repository.

incrementCount(HashMap, Object) - Static method in class com.xerox.bantam.util.AbstractStorage

Increment a counter in a given map.

indexOf(Object) - Method in class com.xerox.bantam.util.DocumentListImpl

indexOfDocument(Document) - Method in interface com.xerox.bantam.DocumentList

Returns the index in this list of the first occurrence of the specified document, or -1 if this list does not contain this document.

indexOfDocument(Document) - Method in class com.xerox.bantam.util.DocumentListImpl

initialize(Class) - Method in class com.xerox.bantam.util.AbstractBackedObject

InternalRepo - Static variable in interface com.xerox.bantam.Storage

Standard ID for the implementation internal repository

INVALID_ARGUMENT - Static variable in class com.xerox.bantam.StorageException

An invalid argument was passed into the Bantam interface.

INVALID_FIELD_DESCRIPTOR - Static variable in class com.xerox.bantam.StorageException

Part of a FieldDescriptor does not make sense.

INVALID_SET - Static variable in class com.xerox.bantam.StorageException

A violation of property-setting semantics occurred.

isEmpty() - Method in interface com.xerox.bantam.CollectionDocument

Returns true if the collection contains no members.

isEnforced(Schema) - Method in interface com.xerox.bantam.Document

Determine whether the specified schema is currently enforced on the document.

isEnforced(Schema) - Method in interface com.xerox.bantam.QueryFactory

Matches documents that have the named schema enforced by the Storage implementation.

isNegated() - Method in class com.xerox.bantam.FieldDescriptor

isOptional() - Method in class com.xerox.bantam.FieldDescriptor

isValid(Object) - Method in class com.xerox.bantam.FieldDescriptor

iterator() - Method in interface com.xerox.bantam.CollectionDocument

Return a set-style iterator over the collection.

L

lastIndexOf(Object) - Method in class com.xerox.bantam.util.DocumentListImpl

lastIndexOfDocument(Document) - Method in interface com.xerox.bantam.DocumentList

Returns the index in this list of the last occurrence of the specified document, or -1 if this list does not contain this document

lastIndexOfDocument(Document) - Method in class com.xerox.bantam.util.DocumentListImpl

LETTER - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

loadValue(Object, Document) - Method in class com.xerox.bantam.util.FieldMapping

M

main(String[]) - Static method in class com.xerox.bantam.StorageException

members - Variable in class com.xerox.bantam.EnumeratedType

The values in this enumerated type.

N

name - Variable in class com.xerox.bantam.Schema

Name of the schema.

NOT_PERMITTED - Static variable in class com.xerox.bantam.StorageException

The underlying storage mechanism does not allow the requested operation.

not(Query) - Method in interface com.xerox.bantam.QueryFactory

Boolean negation of a sub-query: matches documents not matched by the sub-query.

NULL_TREE_LOOKAHEAD - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

O

OBJECT - Static variable in class com.xerox.bantam.DocumentType

open() - Static method in class com.xerox.bantam.util.StorageFactory

Open an instance of the default Storage implementation.

OR - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

or(Query, Query) - Method in interface com.xerox.bantam.QueryFactory

Boolean disjunction of two sub-queries: matches documents matched by either the right or the left sub-query or both.

P

parse(String) - Method in interface com.xerox.bantam.TypeDescriptor

parse the string into an object satisfying the type, if possible return null if that is not possible

parse(String) - Method in class com.xerox.bantam.ClassTypeDescriptor

Try to do something reasonable with the string passed in.

parse(String) - Method in class com.xerox.bantam.EnumeratedType

parse(String) - Method in class com.xerox.bantam.Schema

Create a Schema from a text definition

possibleValues() - Method in interface com.xerox.bantam.TypeDescriptor

return a collection of all possible values of the type.

possibleValues() - Method in class com.xerox.bantam.ClassTypeDescriptor

return null if the possible values can't be enumerated.

possibleValues() - Method in class com.xerox.bantam.EnumeratedType

propertyContains(FieldDescriptor, Object) - Method in interface com.xerox.bantam.QueryFactory

propertyContains(FieldDescriptor, Object) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyContains(String, Object) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the specified value equal to at least one value of the named property according to the semantics of Object.equals, with the following extensions: This predicate will match documents having more than one value for the named property.

propertyContainsText(FieldDescriptor, String) - Method in interface com.xerox.bantam.QueryFactory

propertyContainsText(FieldDescriptor, String) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyContainsText(String, String) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the supplied value as a substring of the String value of the named property.

propertyContainsTextIgnoreCase(FieldDescriptor, String) - Method in interface com.xerox.bantam.QueryFactory

propertyContainsTextIgnoreCase(FieldDescriptor, String) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyContainsTextIgnoreCase(String, String) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the supplied value as a substring of the String value of the named property, ignoring case.

propertyEquals(FieldDescriptor, Object) - Method in interface com.xerox.bantam.QueryFactory

propertyEquals(FieldDescriptor, Object) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyEquals(FieldDescriptor, String) - Method in interface com.xerox.bantam.QueryFactory

Deprecated. Use propertyEquals(FieldDescriptor, Object) instead.

propertyEquals(FieldDescriptor, String) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyEquals(String, Object) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the value of the named property equal to the specified value according to the semantics of Object.equals, with the following extensions: This predicate does not match documents having more than one value for the named property.

propertyEquals(String, String) - Method in interface com.xerox.bantam.QueryFactory

Deprecated. Use propertyEquals(String, Object) instead.

propertyEqualsIgnoreCase(FieldDescriptor, String) - Method in interface com.xerox.bantam.QueryFactory

propertyEqualsIgnoreCase(FieldDescriptor, String) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyEqualsIgnoreCase(String, String) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the String value of the named property equal to the specified value without regard to case, that is, using the semantics of String.equalsIgnoreCase, with the following extensions: This predicate does not match documents having more than one value for the named property.

propertyExists(FieldDescriptor) - Method in interface com.xerox.bantam.Document

Determines whether the property is set by field descriptor.

propertyExists(FieldDescriptor) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having a value for the specified property name.

propertyExists(FieldDescriptor) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyExists(String) - Method in interface com.xerox.bantam.Document

Determines whether the property is set.

propertyExists(String) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having a value for the specified property name.

propertyGreaterThan(FieldDescriptor, Comparable) - Method in interface com.xerox.bantam.QueryFactory

propertyGreaterThan(FieldDescriptor, Comparable) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyGreaterThan(String, Comparable) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the value of the named property which is greater than the specified value according to the semantics of Java Comparable.compareTo, with the following extensions: This predicate does not match documents having more than one value for the named property.

propertyGreaterThanEquals(FieldDescriptor, Comparable) - Method in interface com.xerox.bantam.QueryFactory

propertyGreaterThanEquals(FieldDescriptor, Comparable) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyGreaterThanEquals(String, Comparable) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the value of the named property which is greater than or equal to the specified value according to the semantics of Java Comparable.compareTo(), with the following extensions: This predicate does not match documents having more than one value for the named property.

propertyInSchema(String) - Method in class com.xerox.bantam.util.AbstractDocument

Returns whether the specified property is implicated in any schemas that exist on the document.

propertyLessThan(FieldDescriptor, Comparable) - Method in interface com.xerox.bantam.QueryFactory

propertyLessThan(FieldDescriptor, Comparable) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyLessThan(String, Comparable) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the value of the named property which is less than the specified value according to the semantics of Comparable.compareTo, with the following extensions: This predicate does not match documents having more than one value for the named property.

propertyLessThanEquals(FieldDescriptor, Comparable) - Method in interface com.xerox.bantam.QueryFactory

propertyLessThanEquals(FieldDescriptor, Comparable) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyLessThanEquals(String, Comparable) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the value of the named property which is less than or equal to the specified value according to the semantics of Comparable.compareTo, with the following extensions: This predicate does not match documents having more than one value for the named property.

propertyNotEquals(FieldDescriptor, Object) - Method in interface com.xerox.bantam.QueryFactory

propertyNotEquals(FieldDescriptor, Object) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyNotEquals(FieldDescriptor, String) - Method in interface com.xerox.bantam.QueryFactory

Deprecated. Use propertyNotEquals(FieldDescriptor, Object) instead.

propertyNotEquals(FieldDescriptor, String) - Method in class com.xerox.bantam.util.AbstractQueryFactory

propertyNotEquals(String, Object) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the value of the named property which is not equal to the specified value according to the semantics of Object.equals, with the following extensions: This predicate does not match documents having more than one value for the named property.

propertyNotEquals(String, String) - Method in interface com.xerox.bantam.QueryFactory

Deprecated. Use propertyNotEquals(String, Object) instead.

Q

Query - class com.xerox.bantam.Query.

Base class for queries.

Query(Storage) - Constructor for class com.xerox.bantam.Query

QueryFactory - interface com.xerox.bantam.QueryFactory.

Interface for constructing Query objects; the methods enumerate all permitted query predicate types.

QueryLexer - class com.xerox.bantam.util.QueryLexer.

QueryLexer() - Constructor for class com.xerox.bantam.util.QueryLexer

QueryParser - class com.xerox.bantam.util.QueryParser.

QueryParser() - Constructor for class com.xerox.bantam.util.QueryParser

QueryTokenTypes - interface com.xerox.bantam.util.QueryTokenTypes.

QUESTIONMARK - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

R

register() - Method in class com.xerox.bantam.util.AbstractStorage

register(Storage) - Static method in class com.xerox.bantam.StorageVersion

Each Storage instance should register using this interface when instantiated.

remove(Object) - Method in interface com.xerox.bantam.CollectionDocument

Set method for explicitly removing documents with the same semantics as removeDocument.

remove(Schema) - Method in class com.xerox.bantam.util.SchemaMap

removeAll(Collection) - Method in interface com.xerox.bantam.CollectionDocument

Set method for explicitly removing documents with the same semantics as removeDocuments.

removeAllDocuments(Document) - Method in interface com.xerox.bantam.DocumentList

Removes all occurrences of the specified document, if present

removeAllDocuments(Document) - Method in class com.xerox.bantam.util.DocumentListImpl

removeDocument(Document) - Method in interface com.xerox.bantam.CollectionDocument

Remove the specified document.

removeDocument(Document) - Method in interface com.xerox.bantam.DocumentList

Removes the first occurrence of the specified document, if present

removeDocument(Document) - Method in class com.xerox.bantam.util.DocumentListImpl

removeDocument(String) - Method in interface com.xerox.bantam.CollectionDocument

Version of removeDocument that takes an ID rather than a Document object.

removeDocuments(Collection) - Method in interface com.xerox.bantam.CollectionDocument

Remove all the specified documents.

removePersistentSchema(Schema) - Method in class com.xerox.bantam.util.AbstractDocument

Remove a schema from the permanent schema record.

removeQueryListener(Query, QueryListener) - Method in class com.xerox.bantam.util.AbstractStorage

Remove a query listener from a given storage.

removeValue(FieldDescriptor, Serializable) - Method in interface com.xerox.bantam.Document

Removes a property value if present by field descriptor.

removeValue(FieldDescriptor, Serializable) - Method in class com.xerox.bantam.util.AbstractDocument

Remove a value by field descriptor

removeValue(String, Serializable) - Method in interface com.xerox.bantam.Document

Removes a property value if present.

reset() - Method in interface com.xerox.bantam.CollectionDocument

Reverse all explicit addition and removal operations so that the membership is reset to the set of documents matching the query.

restore() - Method in class com.xerox.bantam.util.AbstractBackedObject

restore() - Method in interface com.xerox.bantam.util.BackedObject

retainAll(Collection) - Method in interface com.xerox.bantam.CollectionDocument

Set method for explicitly removing documents with the same semantics as removeDocuments.

S

saveValue(Object, Document) - Method in class com.xerox.bantam.util.FieldMapping

Schema - class com.xerox.bantam.Schema.

A Schema object is an immutable representation of a Bantam schema.

SCHEMA_VIOLATION - Static variable in class com.xerox.bantam.StorageException

Attempt to put an item in a field which violates the schema's type rules.

Schema.fieldCompare - class com.xerox.bantam.Schema.fieldCompare.

Comparator for partial ordering by field name This comparator is inconsistent with equals for FieldDescriptor

Schema.fieldCompare(Schema) - Constructor for class com.xerox.bantam.Schema.fieldCompare

Schema() - Constructor for class com.xerox.bantam.Schema

Constructor for subclasses which define a schema in code.

Schema(String, FieldDescriptor[]) - Constructor for class com.xerox.bantam.Schema

Construct from field descriptors.

SchemaMap - class com.xerox.bantam.util.SchemaMap.

Implements a map-based container for Schemas; in some sense, the SchemaMap becomes a "super-Schema", since it has several of the same methods.

SchemaMap() - Constructor for class com.xerox.bantam.util.SchemaMap

schemas - Static variable in class com.xerox.bantam.util.SchemaSchema

schemaSchema - Variable in class com.xerox.bantam.util.AbstractDocument

The magic schema that references all other schemas.

SchemaSchema - class com.xerox.bantam.util.SchemaSchema.

This is the schema for all documents that have persistent schemas on them.

SchemaSchema() - Constructor for class com.xerox.bantam.util.SchemaSchema

set(int, Object) - Method in class com.xerox.bantam.util.DocumentListImpl

setContentProvider(String) - Method in interface com.xerox.bantam.ContentDocument

Sets the content provider of this specific document.

setContentType(String) - Method in interface com.xerox.bantam.ContentDocument

Set the MIME type of the content

setDateProperty(Document, String, long) - Static method in class com.xerox.bantam.util.StorageUtil

setDocument(int, Document) - Method in interface com.xerox.bantam.DocumentList

Replaces the document at the specified position with the supplied document.

setDocument(int, Document) - Method in class com.xerox.bantam.util.DocumentListImpl

setMultiValues(FieldDescriptor, Collection) - Method in interface com.xerox.bantam.Document

Sets the values of property by field descriptor.

setMultiValues(String, Collection) - Method in interface com.xerox.bantam.Document

Sets the values of property.

setName(String) - Method in interface com.xerox.bantam.Document

Set the canonical name of the document.

setPropertyValue(FieldDescriptor, Serializable) - Method in interface com.xerox.bantam.Document

Sets the value of a single-valued property by field descriptor.

setPropertyValue(String, Serializable) - Method in interface com.xerox.bantam.Document

Set the value of a single-valued property.

setQuery(Query) - Method in interface com.xerox.bantam.CollectionDocument

Sets the query associated with the collection.

shutdown() - Method in interface com.xerox.bantam.Storage

Cleanly terminate operation of this storage.

size() - Method in interface com.xerox.bantam.CollectionDocument

Returns the number of elements in the collection.

size() - Method in class com.xerox.bantam.Schema

Return the number of entries in this schema.

Storage - interface com.xerox.bantam.Storage.

Interface to a property store.

StorageException - exception com.xerox.bantam.StorageException.

Exception thrown by methods in the Bantam interfaces.

StorageException(Exception) - Constructor for class com.xerox.bantam.StorageException

Constructor for "re"-throwing exceptions encountered inside the Bantam implementation.

StorageException(int, String) - Constructor for class com.xerox.bantam.StorageException

Basic constructor.

StorageException(String) - Constructor for class com.xerox.bantam.StorageException

Basic constructor for internal errors.

StorageException(String, Exception) - Constructor for class com.xerox.bantam.StorageException

Constructor for "re"-throwing exceptions encountered inside the Bantam implementation.

StorageFactory - class com.xerox.bantam.util.StorageFactory.

Generates a Storage according to user-specified parameters.

StorageFactory() - Constructor for class com.xerox.bantam.util.StorageFactory

StorageUtil - class com.xerox.bantam.util.StorageUtil.

Helper routines for Storage.

StorageUtil() - Constructor for class com.xerox.bantam.util.StorageUtil

StorageVersion - class com.xerox.bantam.StorageVersion.

StorageVersion() - Constructor for class com.xerox.bantam.StorageVersion

STRING_LITERAL - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

T

TEXTCONTAINS - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

textContains(String) - Method in interface com.xerox.bantam.QueryFactory

Matches documents having the specified value as a substring of a text extraction of the content.

textContains(String) - Method in class com.xerox.bantam.util.AbstractQueryFactory

toArray() - Method in interface com.xerox.bantam.CollectionDocument

Returns an array of Document objects.

toArray(Object[]) - Method in interface com.xerox.bantam.CollectionDocument

toString() - Method in class com.xerox.bantam.ClassTypeDescriptor

toString() - Method in class com.xerox.bantam.EnumeratedType

toString() - Method in class com.xerox.bantam.FieldDescriptor

toString() - Method in class com.xerox.bantam.DocumentType

toString() - Method in class com.xerox.bantam.Schema

toString() - Method in class com.xerox.bantam.util.FieldMapping

TypeDescriptor - interface com.xerox.bantam.TypeDescriptor.

The interface to a type description object for expressing value type constraints in Schemas.

TYPEMAP - Static variable in class com.xerox.bantam.util.StorageUtil

U

UNDERLYING_EXCEPTION - Static variable in class com.xerox.bantam.StorageException

The underlying Storage mechanism failed.

UNDERSCORE - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

unenforceSchema(Schema) - Method in interface com.xerox.bantam.Document

Stop enforcing the specified schema on the document.

V

validateDelete(Document, String) - Method in class com.xerox.bantam.util.SchemaMap

validateSchema(Schema) - Method in interface com.xerox.bantam.Storage

Validate a schema, verifying that the supplied schema definition is consistent with the current stored data.

validateSetMulti(Document, String, Collection) - Method in class com.xerox.bantam.util.SchemaMap

validateSetMultiSingle(Document, String, Object) - Method in class com.xerox.bantam.util.SchemaMap

validateSetSingle(Document, String, Serializable) - Method in class com.xerox.bantam.util.SchemaMap

version - Variable in class com.xerox.bantam.Schema

Version of the schema.

W

WebRepo - Static variable in interface com.xerox.bantam.Storage

Standard ID for the generic web repository

WS - Static variable in interface com.xerox.bantam.util.QueryTokenTypes

A B C D E F G H I L M N O P Q R S T U V W