|
Xindice API version 1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.xindice.core.filer.Paged
org.apache.xindice.core.filer.BTree
org.apache.xindice.core.indexer.NameIndexer
public final class NameIndexer
NameIndexer is a basic implementation of the Indexer interface. It is used for maintaining element and element@attribute unique indexes.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class org.apache.xindice.core.filer.BTree |
---|
BTree.BTreeFileHeader, BTree.BTreePageHeader, BTree.BTreeRootInfo |
Nested classes/interfaces inherited from class org.apache.xindice.core.filer.Paged |
---|
Paged.FileHeader, Paged.Page, Paged.PageHeader, Paged.PageKey |
Field Summary |
---|
Fields inherited from class org.apache.xindice.core.filer.BTree |
---|
BRANCH, LEAF, STREAM |
Fields inherited from class org.apache.xindice.core.filer.Paged |
---|
CONFIG_DESCRIPTORS_MAX, CONFIG_KEYSIZE_MAX, CONFIG_PAGECOUNT, CONFIG_PAGESIZE, DELETED, NO_PAGE, OVERFLOW, UNUSED |
Fields inherited from interface org.apache.xindice.core.indexer.Indexer |
---|
STYLE_FULLTEXT, STYLE_NODENAME, STYLE_NODEVALUE |
Constructor Summary | |
---|---|
NameIndexer()
|
Method Summary | |
---|---|
void |
add(String value,
Key key,
int pos,
int len,
short elemID,
short attrID)
add adds a Document to the Indexer. |
String |
getIndexStyle()
getIndexStyle returns the Index style. |
String |
getName()
getName retrieves the contextually important name of the object |
String |
getPattern()
getPattern returns the pattern recognized by this Indexer. |
IndexMatch[] |
queryMatches(IndexQuery query)
queryMatches retrieves a set of IndexMatch instances that match the supplied query. |
void |
remove(String value,
Key key,
int pos,
int len,
short elemID,
short attrID)
remove removes all references to the specified Key from the Indexer. |
void |
setCollection(Collection collection)
setCollection tells the Indexer who its parent is. |
void |
setConfig(Configuration config)
setConfig sets the configuration information for the Configurable object instance. |
void |
setLocation(String location)
|
Methods inherited from class org.apache.xindice.core.filer.BTree |
---|
addKey, addValue, addValue, close, create, createBTreeRoot, createBTreeRoot, createFileHeader, createPageHeader, findBTreeRoot, findBTreeRoot, findValue, findValue, getRootNode, getRootNode, open, query, query, removeValue, removeValue, setRootNode, setRootNode |
Methods inherited from class org.apache.xindice.core.filer.Paged |
---|
checkOpened, closeDescriptor, deleteArrayInt, deleteArrayLong, deleteArrayShort, deleteArrayValue, drop, exists, flush, getConfig, getDescriptor, getFile, getFileHeader, getFreePage, getPage, insertArrayInt, insertArrayLong, insertArrayShort, insertArrayValue, isOpened, putDescriptor, readValue, readValue, setFile, unlinkPages, unlinkPages, writeValue, writeValue |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.xindice.core.indexer.Indexer |
---|
flush |
Methods inherited from interface org.apache.xindice.core.DBObject |
---|
close, create, drop, exists, isOpened, open |
Methods inherited from interface org.apache.xindice.util.Configurable |
---|
getConfig |
Constructor Detail |
---|
public NameIndexer()
Method Detail |
---|
public void setConfig(Configuration config)
Configurable
setConfig
in interface Configurable
setConfig
in class Paged
config
- The configuration Nodepublic String getName()
Named
getName
in interface Named
public void setLocation(String location)
public void setCollection(Collection collection)
Indexer
setCollection
in interface Indexer
collection
- The owner Collectionpublic String getIndexStyle()
Indexer
getIndexStyle
in interface Indexer
public String getPattern()
Indexer
contact@name Indexes all contacts by name attribute memo Indexes the text of all memo elements contact@* Indexes all contact attributes *@name Indexes the name attribute for all elements * Indexes the text of all elements *@* Indexes all attributes of all elementsThese patterns are used by the IndexManager when handling SAX events. All events that match the specified pattern will result in an add or remove call to the Indexer.
getPattern
in interface Indexer
public void remove(String value, Key key, int pos, int len, short elemID, short attrID) throws DBException
Indexer
remove
in interface Indexer
value
- The value to removekey
- The Object IDpos
- The offset into the stream the Element occurs atlen
- The length of the substream for the ElementelemID
- The Element ID of the valueattrID
- The Attribute ID of the value (if any, else -1)
DBException
public void add(String value, Key key, int pos, int len, short elemID, short attrID) throws DBException
Indexer
add
in interface Indexer
value
- The value to removekey
- The Object IDpos
- The offset into the stream the Element occurs atlen
- The length of the substream for the ElementelemID
- The Element ID of the valueattrID
- The Attribute ID of the value (if any, else -1)
DBException
public IndexMatch[] queryMatches(IndexQuery query) throws DBException
Indexer
queryMatches
in interface Indexer
query
- The IndexQuery to use
DBException
|
Xindice API version 1.1 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |