org.exist.storage
Class FulltextIndexSpec

java.lang.Object
  org.exist.storage.FulltextIndexSpec

public class FulltextIndexSpec

extends java.lang.Object

Contains information about which parts of a document should be fulltext-indexed for a specified doctype. It basically keeps a list of paths to include and exclude from indexing. Paths are specified using simple XPath syntax, e.g. //SPEECH will select any SPEECH elements, //title/@id will select all id attributes being children of title elements.

Author:

Wolfgang Meier

Field Summary

protected NodePath[]	excludePath
protected boolean	includeAlphaNum
protected boolean	includeAttributes
protected boolean	includeByDefault
protected NodePath[]	includePath
protected NodePath[]	preserveContent

Constructor Summary

FulltextIndexSpec(java.util.Map namespaces, org.w3c.dom.Element node)
Constructor for the IndexPaths object

Method Summary

boolean	getIncludeAlphaNum() Include alpha-numeric data?
boolean	isSelective() Returns false if all elements are indexed, true if indexation is selective.
boolean	match(NodePath path) Check if a given path should be indexed.
boolean	matchAttribute(NodePath path) Check if a given path should be indexed.
boolean	preserveContent(NodePath path) Check if a given path should be preserveContent.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

includePath

protected NodePath[] includePath

excludePath

protected NodePath[] excludePath

preserveContent

protected NodePath[] preserveContent

includeByDefault

protected boolean includeByDefault

includeAttributes

protected boolean includeAttributes

includeAlphaNum

protected boolean includeAlphaNum

Constructor Detail

FulltextIndexSpec

public FulltextIndexSpec(java.util.Map namespaces,
                         org.w3c.dom.Element node)

Constructor for the IndexPaths object

Method Detail

isSelective

public boolean isSelective()

Returns false if all elements are indexed, true if indexation is selective.

Returns:

getIncludeAlphaNum

public boolean getIncludeAlphaNum()

Include alpha-numeric data?

Returns:

match

public boolean match(NodePath path)

Check if a given path should be indexed.

Parameters:

path - path to the node

Returns:

Description of the Return Value

matchAttribute

public boolean matchAttribute(NodePath path)

Check if a given path should be indexed.

Parameters:

path - path to the node

Returns:

Description of the Return Value

preserveContent

public boolean preserveContent(NodePath path)

Check if a given path should be preserveContent.

Parameters:

path - path to the node

Returns:

Description of the Return Value

toString

public java.lang.String toString()