Class javax.help.search.IndexerKit
java.lang.Object
|
+----javax.help.search.IndexerKit
- public abstract class IndexerKit
- extends java.lang.Object
- implements java.lang.Cloneable
Establishes the requirements of an indexing object for a type
of text content. The DefaultKit acts as a factory for policy.
For example, an implementation
for HTML and RTF can be provided that is replaceable
with other implementations.
New kits are normally created by cloning a
prototype kit.
builder
protected IndexBuilder builder
config
protected ConfigFile config
file
protected java.lang.String file
locale
protected java.util.Locale locale
IndexerKit
public IndexerKit()
clone
public abstract java.lang.Object clone()
- Creates a copy of the indexer kit. This
allows an implementation to serve as a prototype
for others, so that they can be quickly created.
- Returns:
- the copy
- Overrides:
- clone in class java.lang.Object
getContentType
public abstract java.lang.String getContentType()
- Gets the MIME type of the data that this
kit represents support for.
- Returns:
- the type
setLocale
public void setLocale(java.util.Locale locale)
- Sets the locale for string tokenizing. A null locale value is valid and means
that no locale has been set for this IndexerKit.
setLocale
public void setLocale(java.lang.String lang)
- Convenience method for setting the locale from a lang string
Takes the lang string in the form of "language_country_variant".
Parses the string and creates an appropriate locale.
- Parameters:
lang
- A string representation of a locale. If lang is null it is the
same as setting the locale to null.
getLocale
public java.util.Locale getLocale()
- Gets the Locale.
parse
public abstract void parse(java.io.Reader in,
java.lang.String file,
boolean ignoreCharset,
IndexBuilder builder,
ConfigFile config) throws java.io.IOException
- Parses content from the given stream. The stream is expected
to be in a format appropriate for this content
handler to parse into tokens according to the locale of the class.
In the absense of a locale, the default locale tokenizer
is used.
- Parameters:
in
- The stream to read from.
file
- The file name being parsed.
builder
- The IndexBuilder for the full text insertion.
config
- The indexer configuration information.
- Throws:
- java.io.IOException - on any I/O error.
parseIntoTokens
public abstract int parseIntoTokens(java.lang.String source,
int pos)
- Parses a string into tokens and stores the tokens.
startStoreDocument
protected abstract void startStoreDocument(java.lang.String file) throws java.lang.Exception
- Starts the storing of the dcoument.
endStoreDocument
protected abstract void endStoreDocument() throws java.lang.Exception
- Ends the storing of the document.
storeToken
protected abstract void storeToken(java.lang.String token,
int pos) throws java.lang.Exception
- Stores a token in the IndexBuilder.
storeTitle
protected abstract void storeTitle(java.lang.String title) throws java.lang.Exception
- Stores a title in the IndexBuilder.