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

A

ACTION - Static variable in class org.erowid.sperowider.htmlshredding.URLMongler
Indicates a URL found as an action attribute of a tag
ADumbIndexFilter - class org.erowid.sperowider.urlfilter.ADumbIndexFilter.
A temporary way of implementing index filtering for Sperowider.
ADumbIndexFilter() - Constructor for class org.erowid.sperowider.urlfilter.ADumbIndexFilter
 
AHandler - class org.erowid.sperowider.AHandler.
Interface that all download handlers must implement
AHandler() - Constructor for class org.erowid.sperowider.AHandler
 
AIncludeExcludeFilter - class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter.
Provides a basic frame for file/url filtering.
AIncludeExcludeFilter() - Constructor for class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
 
ALREADY_GRABBED - Static variable in class org.erowid.sperowider.ASpiderBase
Returned by ASpiderBase.spider(String) to indicate that the download was not done because this file was downloaded under another name.
AMongler - class org.erowid.sperowider.htmlshredding.AMongler.
A generic framework for mongling.
AMongler() - Constructor for class org.erowid.sperowider.htmlshredding.AMongler
 
APPLET - Static variable in class org.erowid.masterdoc.MasterRepository
Applet search engine, for MasterRepository.setSearchEngineType(String).
ASpiderBase - class org.erowid.sperowider.ASpiderBase.
Downloads files to the local drive.
ASpiderBase(IThrottle) - Constructor for class org.erowid.sperowider.ASpiderBase
Instantiates a spider base, with a given throttle.
ASpiderBase() - Constructor for class org.erowid.sperowider.ASpiderBase
Instantiates a spider base with a non-throttle.
add(String, String) - Method in class org.erowid.sperowider.hsqldb.MapTable
Adds a mapping from one value to another value to this map.
add(String) - Method in class org.erowid.sperowider.hsqldb.SetTable
Adds a value to this set.
add(String, String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Adds a mapping from one value to another value to this map.
addAttributesFromTag(HTMLTag) - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Adds in the attributes from one tag into this one.
addDependency(String) - Method in class org.erowid.masterdoc.InternalRepository
Adds an internal dependency.
addDocDir(File) - Method in class org.erowid.masterdoc.InternalRepository
Adds a document directory.
addExclude(Object) - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Adds a string pattern to the list of patterns to exclude.
addExclude(Object) - Method in class org.erowid.sperowider.urlfilter.RegexFilter
Converts the passed in String to a Pattern
addExternalJar(File) - Method in class org.erowid.masterdoc.MasterRepository
Adds an external jar to link to
addFileDescriptor(SplitIndexFileDescriptor) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Returns the map of file descriptors, so that extending classes may manipulate it.
addFileDescriptor(SplitIndexFileDescriptor) - Method in class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor
Adds a file descriptor.
addFileToRectificationQueue(String) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
addFileToRectificationQueue(String) - Method in interface org.erowid.sperowider.ISperowiderModel
Adds a filename to the rectification queue
addFileToRectificationQueue(String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
addFoundURL(String, String, boolean) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
addFoundURL(String, String, boolean) - Method in interface org.erowid.sperowider.ISperowiderModel
The Downloader calls this when it finds a URL in a downloaded page.
addFoundURL(String, String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
Delegates to SperowiderModel.addFoundURL(String, String, boolean) with an exclude flag of false.
addFoundURL(String, String, boolean) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
addFoundURL(String, String) - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
Proposes a URL for future parsing.
addFoundURL(String, String) - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
Proposes a URL for future parsing.
addHTMLTagAttribute(HTMLTagAttribute) - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Adds a new HTMLTagAttribute to this tag
addHandler(String, String, String) - Method in class org.erowid.sperowider.HandlerPool
Adds a new AHandler to the pool, mapped to a specific MIME type and file extension.
addHandlerForFileExtension(String, AHandler) - Method in class org.erowid.sperowider.HandlerPool
Adds a new AHandler, mapped to a specific file extension.
addHandlerForFileExtension(String, String) - Method in class org.erowid.sperowider.HandlerPool
Adds a new AHandler, mapped to a specific file extension.
addHandlerForMimeType(String, AHandler) - Method in class org.erowid.sperowider.HandlerPool
Adds a new AHandler, mapped to a specific MIME type.
addHandlerForMimeType(String, String) - Method in class org.erowid.sperowider.HandlerPool
Adds a new AHandler, mapped to a specific MIME type.
addInclude(Object) - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Adds a string pattern to the list of patterns to include.
addInclude(Object) - Method in class org.erowid.sperowider.urlfilter.RegexFilter
Converts the passed in String to a Pattern
addKeyword(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLKeywordTag
Adds a new keyword
addKeywordList(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLKeywordTag
Adds more keywords
addRepository(Repository) - Method in class org.erowid.masterdoc.MasterRepository
Adds a Repository.
addSearchResultEntry(String, String, String, float) - Method in class org.erowid.sperosearch.SearchResults
Adds a SearchResultEntry to this collection.
addSetting(String, Object) - Method in class org.erowid.sperowider.configuration.Configuration
Adds a setting, with a default.
addSetting(String, boolean) - Method in class org.erowid.sperowider.configuration.Configuration
Adds a setting, with no default.
addSourcePath(File) - Method in class org.erowid.masterdoc.InternalRepository
Adds a source path
addSperowiderModelReporter(ISperowiderModelReporter) - Method in class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
Adds a ISperowiderModelReporter to be delegated to.
addURLToModel(String, URL) - Method in class org.erowid.sperowider.AHandler
All requests to add URLs to the queue come through here, so we do the filtering and logging at this point.
addURLToModel(String, URL) - Method in class org.erowid.sperowider.SperowiderContext
All requests to add URLs to the queue come through here, so we do the filtering and logging at this point.
allow(URL) - Method in class org.erowid.sperowider.DownloaderRobotsFilter
Returns true if the robots.txt file indicates that this URL can be downloaded.
appendHTMLElement(HTMLElement) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Adds a new HTML element to the end of the shredder
available() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
 

B

BACKGROUND - Static variable in class org.erowid.sperowider.htmlshredding.URLMongler
Indicates a URL found as a background attribute of a tag
BAD_HTTP_RESPONSE - Static variable in class org.erowid.sperowider.ASpiderBase
Returned by ASpiderBase.spider(String) to indicate that the download failed because of an HTTP error (a 404, for example).
BasicSperowiderModel - class org.erowid.sperowider.BasicSperowiderModel.
An in-memory implementation of ISperowiderModel.
BasicSperowiderModel() - Constructor for class org.erowid.sperowider.BasicSperowiderModel
 
BasicTable - class org.erowid.sperowider.hsqldb.BasicTable.
Provides basic functionality to classes that want to present Java interfaces to HSQLDB tables.
BasicTable(String, Connection, int) - Constructor for class org.erowid.sperowider.hsqldb.BasicTable
Represents a database table with the given name.
BlocksAllFilter - class org.erowid.sperowider.urlfilter.BlocksAllFilter.
A URL Filter that says "no" to every candidate URL.
BlocksAllFilter() - Constructor for class org.erowid.sperowider.urlfilter.BlocksAllFilter
 

C

CACHED - Static variable in class org.erowid.sperowider.hsqldb.BasicTable
Used in constructors to indicate that data will be stored in a mix of memory and file.
COMPRESS_INDEXES - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Configuration corresponding to SperowiderContext.isCompressIndex().
CONFIGURATION_SOURCE - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Configuration source setting name.
CSSURLMongler - class org.erowid.sperowider.htmlshredding.CSSURLMongler.
This class, when mongle() is called, will call the urlFound() method for each URL that's found, and will replace that url with whatever that method returns.
CSSURLMongler() - Constructor for class org.erowid.sperowider.htmlshredding.CSSURLMongler
 
Configuration - class org.erowid.sperowider.configuration.Configuration.
Holds configuration information for constructing an object.
Configuration() - Constructor for class org.erowid.sperowider.configuration.Configuration
 
characterMatch(int, char) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns true if the character at the position matches the passed in character.
characterMatch(int, char, boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns true if the character at the position matches the passed in character.
charactersMatch(int, char[], boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns true if the characters starting at position match the passed in parameter, without adjusting the current position.
charactersMatch(int, char[]) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns true if the characters starting at position match the passed in parameter, without adjusting the current position.
clone() - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
 
clone() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
 
clone() - Method in class org.erowid.sperosearch.splitindex.SplitIndexLuceneInputStream
 
clone() - Method in class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor
 
close() - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Closes this directory and cleans up resources.
close() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
 
close() - Method in class org.erowid.sperosearch.splitindex.SplitIndexLuceneInputStream
 
close() - Method in class org.erowid.sperosearch.splitindex.SplitIndexSegmentFactory
Cleans up resources.
close() - Method in class org.erowid.sperowider.Indexer
Optimizes and closes the newly created Lucene index.
compare(File, File) - Static method in class org.erowid.sperowider.FileUtils
Compares two files or directories and returns true if they both exist and they both have the same contents, or if neither exists.
compare(InputStream, InputStream) - Static method in class org.erowid.sperowider.FileUtils
Compares two IO streams and returns true if they match.
contains(String) - Method in class org.erowid.sperowider.hsqldb.MapTable
Returns true if the map contains this key.
contains(String) - Method in class org.erowid.sperowider.hsqldb.SetTable
Returns true if the set contains this key.
contains(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Returns true if either column has this value.
containsFirst(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Returns true if the first column has this value.
containsSecond(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Returns true if the second column has this value.
copy(InputStream, OutputStream) - Static method in class org.erowid.sperowider.FileUtils
Copies for an input stream to a file.
copyDirectory(File, File) - Static method in class org.erowid.sperowider.FileUtils
Copies the contents of one directory, recursively, to another.
copyFile(String, File) - Static method in class org.erowid.sperowider.FileUtils
Copies for an input stream to a file.
copyFile(File, String) - Static method in class org.erowid.sperowider.FileUtils
Copies for an input stream to a file.
copyFile(String, String) - Static method in class org.erowid.sperowider.FileUtils
Copies for an input stream to a file.
copyFile(File, File) - Static method in class org.erowid.sperowider.FileUtils
Copies for an input stream to a file.
create() - Method in class org.erowid.sperowider.hsqldb.MapTable
Creates a new table in the backing database corresponding to this object.
create() - Method in class org.erowid.sperowider.hsqldb.SetTable
Creates a new table in the backing database corresponding to this object.
create() - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Creates a new table in the backing database corresponding to this object.
createFile(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Does nothing, because this is a read only directory.
createFile(String) - Static method in class org.erowid.sperowider.FileUtils
Creates a file at a given location.
createFile(File) - Static method in class org.erowid.sperowider.FileUtils
Creates a file at a given location.

D

DESCRIPTOR_FILE_NAME - Static variable in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Name of the descriptor file.
DESCRIPTOR_VERSION_NUMBER - Static variable in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
The descriptor version.
DOWNLOAD - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.DOWNLOAD_LOGNAME
DOWNLOAD_DOWNLOAD - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.DOWNLOAD_DOWNLOAD_LOGNAME
DOWNLOAD_DOWNLOAD_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "download.download" in the log4j configuration to indicate the logger that is used to show actual data downloads.
DOWNLOAD_ERROR - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.DOWNLOAD_ERROR_LOGNAME
DOWNLOAD_ERROR_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "download.error" in the log4j configuration to indicate the logger that is used to show generic download errors.
DOWNLOAD_INVALIDURL - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.DOWNLOAD_INVALIDURL_LOGNAME
DOWNLOAD_INVALIDURL_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "download.invalidurl" in the log4j configuration to indicate the logger that is used to show invalid URLs.
DOWNLOAD_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "download" in the log4j configuration file to indicate all of the download loggers.
DOWNLOAD_ROOT - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Download root setting name.
DOWNLOAD_SPIDER - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.DOWNLOAD_SPIDER_LOGNAME
DOWNLOAD_SPIDER_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "download.spider" in the log4j configuration to indicate the logger that is used to show spidering events.
DOWNLOAD_URLFOUND - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.DOWNLOAD_URLFOUND_LOGNAME
DOWNLOAD_URLFOUND_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "download.urlfound" in the log4j configuration file to indicate the logger that is used to show when URLs are found.
DOWNLOAD_URLMAP - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.DOWNLOAD_URLMAP_LOGNAME
DOWNLOAD_URLMAP_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "download.urlmap" in the log4j configuration to indicate the logger that is used to show when a URL is mapped to another URL, or to a filename.
DOWNLOAD_URLPOPFROMQUEUE - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.DOWNLOAD_URLPOPFROMQUEUE_LOGNAME
DOWNLOAD_URLPOPFROMQUEUE_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "download.urlpopfromqueue" in the log4j configuration to indicate the logger that is used to show when URLs are popped from the queue.
DownloadRunner - class org.erowid.sperowider.DownloadRunner.
Does the downloading, using repeated calls to a Downloader class.
DownloadRunner(SperowiderContext, int) - Constructor for class org.erowid.sperowider.DownloadRunner
Instantiates a downloader, with a given download model.
Downloader - class org.erowid.sperowider.Downloader.
Downloads files to the local drive.
Downloader(SperowiderContext) - Constructor for class org.erowid.sperowider.Downloader
Instantiates a downloader, with a given download model.
DownloaderRobotsFilter - class org.erowid.sperowider.DownloaderRobotsFilter.
Provides robots.txt filtering for the Downloader.
DownloaderRobotsFilter() - Constructor for class org.erowid.sperowider.DownloaderRobotsFilter
 
deleteFile(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Does nothing, because this is a read only directory.
deleteFilesRecursively(File) - Static method in class org.erowid.sperowider.FileUtils
Does a recursive delete on a directory
deleteHTMLElement(int) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Deletes an HTML element at the given position, and moves the rest to the left
destroy() - Method in class org.erowid.sperosearch.SearcherApplet
Automatically called by the Java Plugin.
destroy() - Method in class org.erowid.sperowider.BasicSperowiderModel
 
destroy() - Method in interface org.erowid.sperowider.ISperowiderModel
Called by the Sperowider to close all open resources
destroy() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
destroy() - Method in class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
Delegates to stopping reporting
destroy() - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
Called by the Sperowider to close all open resources
destroy() - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
Does nothing.
download(HttpURLConnection, String, String) - Method in class org.erowid.sperowider.AHandler
This method is responsible for downloading the data at the passed in connection, and processing as appropriate (including, for example, spidering, adding it to the rectification queue, etc.)
download(HttpURLConnection, String, String) - Method in class org.erowid.sperowider.GenericHandler
Does a bytewise download of the file, with no manipulation, no indications for rectifying, and in a thread.
download(HttpURLConnection, String, String) - Method in class org.erowid.sperowider.PatternMatchingHandler
Downloads a file via the passed in connection, and detects URLs using the Sperowider pattern matching command embedded in the found file.
download(HttpURLConnection, String, String) - Method in class org.erowid.sperowider.TextCssHandler
Downloads a CSS file and add found URLs (as indicated by url() in the CSS file) to the rectification queue.
download(HttpURLConnection, String, String) - Method in class org.erowid.sperowider.TextHtmlHandler
Downloads files, and adds found URLs to the rectification queue.
downloadMatch(String) - Method in class org.erowid.sperowider.urlfilter.BlocksAllFilter
Returns false
downloadMatch(String) - Method in interface org.erowid.sperowider.urlfilter.IDownloadFilter
Given a URL, returns true if that URL should be downloaded.
downloadMatch(String) - Method in class org.erowid.sperowider.urlfilter.NoHopRegexSperowiderFilter
Returns true if the passed in URL matches at least one of the include patterns, and matches none of the exclude patterns.
downloadMatch(String) - Method in class org.erowid.sperowider.urlfilter.NoHopSimpleSperowiderFilter
Returns true if the passed in URL matches at least one of the include patterns, and matches none of the exclude patterns.
downloadMatch(String) - Method in class org.erowid.sperowider.urlfilter.OneHopRegexSperowiderFilter
Returns true if the passed in URL matches at least one of the include patterns, and matches none of the exclude patterns.
downloadMatch(String) - Method in class org.erowid.sperowider.urlfilter.OneHopSimpleSperowiderFilter
Returns true if the passed in URL matches at least one of the include patterns, and matches none of the exclude patterns.

E

EMPTY_ARRAY - Static variable in class org.erowid.sperowider.htmlshredding.RawHtmlData
An empty character array
EXCEPTION - Static variable in class org.erowid.sperowider.ASpiderBase
Returned by ASpiderBase.spider(String) to indicate that the download failed because of a thrown exception.
ExternalLink - class org.erowid.masterdoc.ExternalLink.
A link that can be exposed by an Internal API.
ExternalLink() - Constructor for class org.erowid.masterdoc.ExternalLink
 
ExternalRepository - class org.erowid.masterdoc.ExternalRepository.
An external API
ExternalRepository(String, String, String, String, String) - Constructor for class org.erowid.masterdoc.ExternalRepository
 
execSQL(String) - Method in class org.erowid.sperowider.hsqldb.BasicTable
Convenience method to execute some SQL.

F

FILTER_FAILURE - Static variable in class org.erowid.sperowider.ASpiderBase
Returned by ASpiderBase.spider(String) to indicate that the download was not done because it was blocked by a filter (either robots.txt or the Sperowider filter itself).
FileNameManager - class org.erowid.sperowider.FileNameManager.
Maps URLs to file names.
FileNameManager(String) - Constructor for class org.erowid.sperowider.FileNameManager
Creates a new FileNameManager, with the passed in String indicating the root of the download tree.
FileUtils - class org.erowid.sperowider.FileUtils.
Simple file utilities.
FileUtils() - Constructor for class org.erowid.sperowider.FileUtils
 
fileExists(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Returns true if the requested file exists in this directory.
fileExists(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Checks for file existence.
fileLength(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Returns the length of the named file.
fileModified(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Always returns 0, because this is a read only directory.
findMetaTag(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Finds the index of the HTMLMetaTag with the given name property.
findTag(int, String) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Returns the index of the first tag found with the passed in name, starting at the start index.
fixURL(URL) - Static method in class org.erowid.sperowider.FileNameManager
Cleans up URLs
foundEmbeddedScript(ScriptTag) - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Called when the shmongler finds embedded scripts
foundHTMLComment(HTMLComment) - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Called when the shmongler finds a comment
foundHTMLDocType(HTMLDocType) - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Called when the shmongler finds an DocType entry
foundHTMLKeywordTag(HTMLKeywordTag) - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Called when the shmongler finds a keyword meta tag
foundHTMLMetaTag(HTMLMetaTag) - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Called when the shmongler finds a meta tag of any kind but meta
foundHTMLTag(HTMLTag) - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Called when the shmongler finds a HTML tag not handled by a more specific method
foundHTMLText(HTMLText) - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Called when the shmongler finds HTML text

G

GeneratorApi - class org.erowid.masterdoc.GeneratorApi.
Generates the internal APIs
GeneratorApi(MasterRepository) - Constructor for class org.erowid.masterdoc.GeneratorApi
Default constructor
GeneratorDocBase - class org.erowid.masterdoc.GeneratorDocBase.
Generates the docbase.
GeneratorDocBase(MasterRepository) - Constructor for class org.erowid.masterdoc.GeneratorDocBase
Default constructor
GeneratorMain - class org.erowid.masterdoc.GeneratorMain.
Given a MasterRepository, this class will generate the documentation by delegating to the other "generator" classes : GeneratorApi, GeneratorDocBase, and GeneratorSearchBase.
GeneratorMain(MasterRepository) - Constructor for class org.erowid.masterdoc.GeneratorMain
Default constructor, takes the repository to generate the docs for.
GeneratorMasterDocPages - class org.erowid.masterdoc.GeneratorMasterDocPages.
Generates the MasterDoc specific pages.
GeneratorMasterDocPages(MasterRepository) - Constructor for class org.erowid.masterdoc.GeneratorMasterDocPages
Default constructor
GeneratorSearchBase - class org.erowid.masterdoc.GeneratorSearchBase.
Generates the search data.
GeneratorSearchBase(MasterRepository) - Constructor for class org.erowid.masterdoc.GeneratorSearchBase
Default constructor
GenericHandler - class org.erowid.sperowider.GenericHandler.
This class downloads generically.
GenericHandler() - Constructor for class org.erowid.sperowider.GenericHandler
 
generate() - Method in class org.erowid.masterdoc.GeneratorApi
Generates the internal APIs
generate() - Method in class org.erowid.masterdoc.GeneratorDocBase
Generates docs and links pages.
generate() - Method in class org.erowid.masterdoc.GeneratorMain
Generates the docs.
generate() - Method in class org.erowid.masterdoc.GeneratorMasterDocPages
Generates the MasterDoc pages
generate() - Method in class org.erowid.masterdoc.GeneratorSearchBase
Generates the searchbase
generateConfigurationReport(PrintWriter) - Method in class org.erowid.sperowider.configuration.Configuration
Generates a list of what the configured settings are.
generateMasterRepository(String) - Static method in class org.erowid.masterdoc.MasterDocConfigurator
Generates a MasterRepository from an XML config file
generateSummaryFooter(String) - Method in class org.erowid.sperowider.SummaryReportGenerator
Generates page footer
generateSummaryFooter() - Method in class org.erowid.sperowider.SummaryReportGenerator
Generates page footer
generateSummaryHeader(String, String) - Method in class org.erowid.sperowider.SummaryReportGenerator
Generates page header, using the named file as the header, instead of the default bland header.
generateSummaryHeader(String) - Method in class org.erowid.sperowider.SummaryReportGenerator
Generates page header, using the default bland header.
get(String) - Method in class org.erowid.sperowider.configuration.Configuration
Returns the value for a setting.
getApiUrl() - Method in class org.erowid.masterdoc.ExternalRepository
 
getAsBoolean(String) - Method in class org.erowid.sperowider.configuration.Configuration
Returns the value for a setting.
getAsCollection(String) - Method in class org.erowid.sperowider.configuration.Configuration
Returns the value for a setting.
getAsLong(String) - Method in class org.erowid.sperowider.configuration.Configuration
Returns the value for a setting.
getAsString(String) - Method in class org.erowid.sperowider.configuration.Configuration
Returns the value for a setting.
getClassPath() - Method in class org.erowid.masterdoc.MasterRepository
Returns the classpath that includes all the included jars.
getConnection() - Method in class org.erowid.sperowider.hsqldb.BasicTable
The database connection to the database containing this table.
getConnection() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
Returns the current HSQLDB connection.
getContent() - Method in class org.erowid.sperowider.htmlshredding.HTMLMetaTag
Returns the content attribute
getContext() - Method in class org.erowid.sperowider.Sperowider
Returns the SperowiderContext.
getData(int) - Method in class org.erowid.sperosearch.splitindex.SplitIndexSegment
Returns the byte (as an int) at the given position.
getData() - Method in class org.erowid.sperowider.hsqldb.SetTable
Returns a copy of the data in this table, as a List of String.
getDefaultHandler() - Method in class org.erowid.sperowider.HandlerPool
Returns the default handler, the AHandler that will be used for unrecognized MIME types and file extensions.
getDependencies() - Method in class org.erowid.masterdoc.InternalRepository
Returns the internal dependencies for this repository.
getDescription() - Method in class org.erowid.masterdoc.ExternalLink
Returns the description.
getDescription() - Method in class org.erowid.sperosearch.SearchResultEntry
Returns the description of this search result.
getDescriptor() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
Returns the descriptor.
getDirectory(URL) - Static method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
A factory for creating/returning an HttpDirectory for the passed in URL.
getDirectoryDescriptor() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor
Returns the directoryDescriptor.
getDocDirs() - Method in class org.erowid.masterdoc.InternalRepository
Returns a list of document directories, as File.
getDocType() - Method in class org.erowid.sperowider.htmlshredding.HTMLDocType
 
getDownloadRoot() - Method in class org.erowid.sperowider.SperowiderContext
 
getDownloadSpiderFilter() - Method in class org.erowid.sperowider.urlfilter.NoHopRegexSperowiderFilter
Returns the filter used to make decisions about what Urls to download and spider.
getDownloadSpiderFilter() - Method in class org.erowid.sperowider.urlfilter.NoHopSimpleSperowiderFilter
Returns the filter used to make decisions about what Urls to download and spider.
getDownloadSpiderFilter() - Method in class org.erowid.sperowider.urlfilter.OneHopRegexSperowiderFilter
Returns the filter used to make decisions about what Urls to download and spider.
getDownloadSpiderFilter() - Method in class org.erowid.sperowider.urlfilter.OneHopSimpleSperowiderFilter
Returns the filter used to make decisions about what Urls to download and spider.
getDownloadStatisticCount(int) - Method in class org.erowid.sperowider.ASpiderBase
Returns the number of downloads that have resulted in the passed in status.
getDownloadStatisticCount(int) - Method in class org.erowid.sperowider.DownloadRunner
Returns the number of downloads that have resulted in the passed in status.
getDownloadStatisticCount(int) - Method in class org.erowid.sperowider.Sperowider
Returns the number of files downloaded per download status (ASpiderBase.ALREADY_GRABBED, ASpiderBase.BAD_HTTP_RESPONSE, ASpiderBase.EXCEPTION, ASpiderBase.FILTER_FAILURE, ASpiderBase.SUCCESS.
getElements() - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Returns an iterator representing the HTML elements in order
getErrorMessage() - Method in class org.erowid.sperosearch.SearcherApplet
Returns the error message that interrupted the last search, if there is one.
getExcludes() - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Returns the list of include patterns
getExternalApiRoot() - Method in class org.erowid.masterdoc.MasterRepository
 
getExternalDocRoot() - Method in class org.erowid.masterdoc.MasterRepository
Returns the external Doc Root.
getExternalRepositories() - Method in class org.erowid.masterdoc.MasterRepository
 
getExternalRepository(String) - Method in class org.erowid.masterdoc.MasterRepository
Returns a named external repository
getExternalSearchRoot() - Method in class org.erowid.masterdoc.MasterRepository
Returns the externalSearchRoot.
getFile() - Method in class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor
The File of this directory, for writing.
getFileContent(String) - Static method in class org.erowid.sperowider.FileUtils
Pumps the contents of a file into a StringBuffer.
getFileDescriptor(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Gets a file descriptor by name.
getFileForRectifying() - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getFileForRectifying() - Method in interface org.erowid.sperowider.ISperowiderModel
Returns a file to be rectified; this will be done after the downloads are all done
getFileForRectifying() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getFileName() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor
Returns the fileName.
getFileNameForURL(String) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getFileNameForURL(URL, String, String, String[]) - Method in class org.erowid.sperowider.FileNameManager
Returns a calculated filename for the passed in URL.
getFileNameForURL(String) - Method in interface org.erowid.sperowider.ISperowiderModel
Returns the filename for a mapped URL.
getFileNameForURL(String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getFileNameManager() - Method in class org.erowid.sperowider.SperowiderContext
 
getFileOutputStream(String) - Method in class org.erowid.sperowider.AHandler
Returns an OutputStream to allow extending classes to write to the named file.
getFileOutputStream(File) - Static method in class org.erowid.sperowider.FileUtils
Gets an output stream for a given file name, creating the file if necessary.
getFileOutputStream(String) - Static method in class org.erowid.sperowider.FileUtils
Gets an output stream for a given file name, creating the file if necessary.
getFilePrintWriter(File) - Static method in class org.erowid.sperowider.FileUtils
Gets an PrintWriter for a given file name, creating the file if necessary.
getFilePrintWriter(String) - Static method in class org.erowid.sperowider.FileUtils
Gets an PrintWriter for a given file name, creating the file if necessary.
getFileRectifyCount() - Method in class org.erowid.sperowider.RectifierRunner
Returns the number of files rectified
getFileRectifyCount() - Method in class org.erowid.sperowider.Sperowider
Gets the number of files rectified.
getFilenameRelativeToRoot(String) - Method in class org.erowid.sperowider.FileNameManager
Returns the filename relative to the download root, as returned by FileNameManager.getRoot().
getFollowChar() - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Returns the follow character for this tag.
getFoundURLs(String) - Method in class org.erowid.sperowider.BasicSperowiderModel
This is too expensive for the BasicSperowiderModel, in terms of memory.
getFoundURLs(String) - Method in interface org.erowid.sperowider.ISperowiderModel
Returns a List of String objects that are the URLs that the passed in URL reference.
getFoundURLs(String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getFoundURLs(String) - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
Returns a List of String objects that are the URLs that the passed in URL reference.
getFoundURLs(String) - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
This method is not supported in this model.
getGeneralUrl() - Method in class org.erowid.masterdoc.Repository
 
getGrabbedUrlCount() - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getGrabbedUrlCount() - Method in interface org.erowid.sperowider.ISperowiderModel
The count of URLs that have been grabbed for download.
getGrabbedUrlCount() - Method in class org.erowid.sperowider.Sperowider
The count of URLs that have been grabbed for download.
getGrabbedUrlCount() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getHTMLElement(int) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Returns the HTML element at a given position
getHTMLElementCount() - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Returns the current count of elements
getHTMLTagAttribute(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Returns the HTMLTagAttribute with the given attribute name.
getHTMLTagAttributes() - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Returns an Iterator pointing to the list of HTMLTagAttribute
getHandlerForFileExtension(String) - Method in class org.erowid.sperowider.HandlerPool
Returns an AHandler for the passed in file extension.
getHandlerForMimeType(String) - Method in class org.erowid.sperowider.HandlerPool
Returns an AHandler for the passed in MIME type.
getHandlerPool() - Method in class org.erowid.sperowider.SperowiderContext
 
getHttpResponseCodeCount(int) - Method in class org.erowid.sperowider.ASpiderBase
Returns the number of Http responses of each kind.
getHttpResponseCodeCount(int) - Method in class org.erowid.sperowider.DownloadRunner
Returns the number of Http responses of each kind.
getHttpResponseCodeCount(int) - Method in class org.erowid.sperowider.Sperowider
Gets the number of responses per HTTP code.
getIncludeText() - Method in class org.erowid.sperowider.SperowiderCommandInterpreter
Returns the include text corresponding to the recent include command.
getIncludes() - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Returns the list of include patterns
getIndexLimit() - Method in class org.erowid.sperowider.SperowiderContext
Returns the number of characters to be indexed.
getIndexedFileCount() - Method in class org.erowid.sperowider.IndexerRunner
Returns the number of files indexed
getIndexedFileCount() - Method in class org.erowid.sperowider.Sperowider
Gets the number of files indexed
getInstance(URL) - Static method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Creates a read only directory descriptor.
getInternalApiRoot() - Method in class org.erowid.masterdoc.MasterRepository
 
getInternalDocRoot() - Method in class org.erowid.masterdoc.MasterRepository
Returns the internal Doc Root.
getInternalMainRoot() - Method in class org.erowid.masterdoc.MasterRepository
 
getInternalRepositories() - Method in class org.erowid.masterdoc.MasterRepository
 
getInternalRepository(String) - Method in class org.erowid.masterdoc.MasterRepository
Returns a named internal repository
getInternalSearchRoot() - Method in class org.erowid.masterdoc.MasterRepository
Returns the internalSearchRoot.
getInvalidURLCount() - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getInvalidURLCount() - Method in interface org.erowid.sperowider.ISperowiderModel
The count of all bad URLs, both found and real.
getInvalidURLCount() - Method in class org.erowid.sperowider.Sperowider
The count of all bad URLs, both found and real.
getInvalidURLCount() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getInvalidURLs() - Method in class org.erowid.sperowider.BasicSperowiderModel
Returns the list of invalid URLs
getInvalidURLs() - Method in interface org.erowid.sperowider.ISperowiderModel
Returns the list of invalid URLs
getInvalidURLs() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getInvalidURLs() - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
Returns the list of invalid URLs
getInvalidURLs() - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
Returns the set of invalid URLs
getKeywordList() - Method in class org.erowid.sperowider.htmlshredding.HTMLKeywordTag
Gets all the keywords
getLeadChar() - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Returns the lead character.
getLength() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
Returns the length.
getLogger() - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Returns the logger associated with this Shmongler
getLogger() - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Returns shredder logger
getLongDescription() - Method in class org.erowid.masterdoc.Repository
 
getMessage(String) - Method in class org.erowid.sperowider.configuration.Configuration
Returns the default/required message for a setting.
getMissingSettings() - Method in class org.erowid.sperowider.configuration.Configuration
Returns a List of String names that are required, but are not filled in (either by defaults or by calling Configuration.set(String, Object) or Configuration.setUnlessSet(String, Object).
getMode() - Method in class org.erowid.sperowider.hsqldb.BasicTable
Returns the mode value, which is either BasicTable.MEMORY or BasicTable.CACHED.
getName() - Method in class org.erowid.masterdoc.ExternalLink
Returns the name.
getName() - Method in class org.erowid.masterdoc.Repository
 
getName() - Method in class org.erowid.sperowider.hsqldb.BasicTable
Returns the table name.
getName() - Method in class org.erowid.sperowider.htmlshredding.HTMLMetaTag
Returns the name attribute
getName() - Method in class org.erowid.sperowider.htmlshredding.HTMLTagAttribute
Gets the attribute name.
getPathFromFileList(List) - Static method in class org.erowid.masterdoc.Repository
Returns a path string from a list of files.
getPathToArchiveRoot(String) - Method in class org.erowid.sperowider.FileNameManager
Returns the path from the passed in filename to the download root, as returned by FileNameManager.getRoot().
getPathToDocRoot(String) - Method in class org.erowid.sperowider.FileNameManager
Returns a path to the document root for the passed in filename.
getPattern() - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
Gets the pattern used to find URLs
getPosition() - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Gets the current position
getRealURLForFoundURL(String) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getRealURLForFoundURL(String) - Method in interface org.erowid.sperowider.ISperowiderModel
Returns the mapping data as set by ISperowiderModel.mapFoundURLToRealURL(String, String)
getRealURLForFoundURL(String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getRectifiedHTMLFileCount() - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getRectifiedHTMLFileCount() - Method in interface org.erowid.sperowider.ISperowiderModel
The count of all HTML files that have been "rectified", that have been processed to replace all found URLs with relative URLs to the mapped file names.
getRectifiedHTMLFileCount() - Method in class org.erowid.sperowider.Sperowider
The count of all HTML files that have been "rectified", that have been processed to replace all found URLs with relative URLs to the mapped file names.
getRectifiedHTMLFileCount() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getRelativeFilename(String, String) - Method in class org.erowid.sperowider.FileNameManager
Gets a relative filename from the source file to the destination file.
getReplaceableFilenameSuffixes() - Method in class org.erowid.sperowider.AHandler
This works with AHandler.getRequiredFilenameSuffix() by providing a list of suffixes that could simply be replaced with the value returned by AHandler.getRequiredFilenameSuffix().
getReplaceableFilenameSuffixes() - Method in class org.erowid.sperowider.TextHtmlHandler
Returns ".shtml", ".php", ".asp", ".jsp", and ".do".
getReplacementRegex() - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
Gets the replacement pattern to replace found URLs with.
getRequiredFilenamePrefix() - Method in class org.erowid.sperowider.AHandler
Implementing classes can override this method to force files downloaded by this handler to start with a guaranteed prefix.
getRequiredFilenameSuffix() - Method in class org.erowid.sperowider.AHandler
Implementing classes can override this method to force files downloaded by this handler to end with a guaranteed suffix.
getRequiredFilenameSuffix() - Method in class org.erowid.sperowider.TextHtmlHandler
All downloaded HTML files should end with ".html"
getResultCount() - Method in class org.erowid.sperosearch.SearchResults
Returns the number of SearchResultEntry objects in this collection.
getResultCount() - Method in class org.erowid.sperosearch.SearcherApplet
Returns the number of URLs found in the last search.
getResultDescription(int) - Method in class org.erowid.sperosearch.SearcherApplet
Returns the description of the resultIndexth page found in the last search.
getResultTitle(int) - Method in class org.erowid.sperosearch.SearcherApplet
Returns the title of the resultIndexth page found in the last search.
getResultURL(int) - Method in class org.erowid.sperosearch.SearcherApplet
Returns the URL of the resultIndexth page found in the last search.
getResultWeight(int) - Method in class org.erowid.sperosearch.SearcherApplet
Returns the weight of the resultIndexth page found in the last search.
getRoot() - Method in class org.erowid.sperowider.FileNameManager
Returns the root of the download tree.
getRowCount() - Method in class org.erowid.sperowider.hsqldb.SetTable
Returns the number of rows in this table, or -1 if the table has not been created.
getSearchEngineType() - Method in class org.erowid.masterdoc.MasterRepository
 
getSearchIndexRoot() - Method in class org.erowid.sperowider.FileNameManager
Returns the directory that the search indexes will be created in.
getSearchResultEntry(int) - Method in class org.erowid.sperosearch.SearchResults
Returns the SearchResultEntry at the index.
getSegment() - Method in class org.erowid.sperosearch.splitindex.SplitIndexSegment
Returns the segment.
getSegment(SplitIndexFileDescriptor, int) - Method in class org.erowid.sperosearch.splitindex.SplitIndexSegmentFactory
Returns the segment corresponding to the passed in logical file and segment.
getSegmentCount() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor
Returns the number of segments in this file.
getSegmentFilename(int) - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor
Returns the filename for a specific segment.
getSegmentSize() - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Returns the size of a given segment, before compression.
getShortDescription() - Method in class org.erowid.masterdoc.Repository
 
getSize() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor
Returns the uncompressed size of this logical file.
getSize() - Method in class org.erowid.sperosearch.splitindex.SplitIndexSegment
The actual segment size.
getSourcePath() - Method in class org.erowid.masterdoc.InternalRepository
Returns the source path
getSourceURLs(String) - Method in class org.erowid.sperowider.BasicSperowiderModel
This is too expensive for the BasicSperowiderModel, in terms of memory.
getSourceURLs(String) - Method in interface org.erowid.sperowider.ISperowiderModel
Returns a List of String objects that are the URLs in which the passed in URL is found.
getSourceURLs(String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getSourceURLs(String) - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
Returns a List of String objects that are the URLs in which the passed in URL is found.
getSourceURLs(String) - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
This method is not supported in this model.
getSperowiderContext() - Method in class org.erowid.sperowider.AHandler
 
getSperowiderModel() - Method in class org.erowid.sperowider.SperowiderContext
 
getSpiderQueueSize() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getSpiderQueueSize() - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
The number of URLs left in the queue.
getSpiderQueueSize() - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
The number of URLs left in the queue.
getTableCreatePrefix() - Method in class org.erowid.sperowider.hsqldb.BasicTable
Uses BasicTable.getMode() to return either "create cached table" or "create memory table".
getTagName() - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Returns the tag name, the thing that starts a tag off (the "a" in "", etc.)
getText() - Method in class org.erowid.sperowider.htmlshredding.HTMLComment
 
getText() - Method in class org.erowid.sperowider.htmlshredding.HTMLText
 
getThrottle() - Method in class org.erowid.sperowider.SperowiderContext
 
getTitle() - Method in class org.erowid.sperosearch.SearchResultEntry
Returns the title of the web page represented by this search result.
getTotalDownloadAttempts() - Method in class org.erowid.sperowider.ASpiderBase
Returns the total number of download attempts.
getTotalDownloadAttempts() - Method in class org.erowid.sperowider.DownloadRunner
Returns the total number of download attempts.
getTotalDownloadAttempts() - Method in class org.erowid.sperowider.Sperowider
Gets the total number of download attempts.
getTotalHttpAttempts() - Method in class org.erowid.sperowider.ASpiderBase
Returns the total number of download attempts.
getTotalHttpAttempts() - Method in class org.erowid.sperowider.DownloadRunner
Returns the total number of download attempts.
getTotalHttpAttempts() - Method in class org.erowid.sperowider.Sperowider
This is higher than the number of downloads, because each 302 counts here as well.
getURL() - Method in class org.erowid.sperosearch.SearchResultEntry
Returns the URL, as a String, of this search result.
getURLFilter() - Method in class org.erowid.sperowider.SperowiderContext
 
getURLGroup() - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
Gets the number of the pattern group in the pattern set by PatternMatchingMongler.setPattern(String) that has the actual URL in it.
getURLs() - Method in class org.erowid.sperowider.SperowiderCommandInterpreter
Returns the URLs contained in the recent loadurls command, if the most recent command was one.
getUnRectifiedFileCount() - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getUnRectifiedFileCount() - Method in interface org.erowid.sperowider.ISperowiderModel
The count of downloaded HTML files that are not yet rectified.
getUnRectifiedFileCount() - Method in class org.erowid.sperowider.Sperowider
The count of downloaded HTML files that are not yet rectified.
getUnRectifiedFileCount() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getUncheckedUrlCount() - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getUncheckedUrlCount() - Method in interface org.erowid.sperowider.ISperowiderModel
A count of URLs that have not yet been checked.
getUncheckedUrlCount() - Method in class org.erowid.sperowider.Sperowider
A count of URLs that have not yet been checked.
getUncheckedUrlCount() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getUnspideredUrl() - Method in class org.erowid.sperowider.BasicSperowiderModel
 
getUnspideredUrl() - Method in interface org.erowid.sperowider.ISperowiderModel
Returns a URL that has yet to be downloaded
getUnspideredUrl() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
getUnspideredUrl() - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
Returns a URL for parsing.
getUnspideredUrl() - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
Returns a URL for parsing.
getUrl() - Method in class org.erowid.masterdoc.ExternalLink
Returns the url.
getUrl() - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
The URL of this directory, for reading.
getUrlForReading(int) - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor
The URL of this directory, for reading.
getValue() - Method in class org.erowid.sperowider.htmlshredding.HTMLTagAttribute
Gets the attribute value.
getWeight() - Method in class org.erowid.sperosearch.SearchResultEntry
Returns the weight of this search result.
grabForSpidering(String) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
grabForSpidering(String) - Method in interface org.erowid.sperowider.ISperowiderModel
If this URL has already been downloaded, return false.
grabForSpidering(String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
gunzip(String) - Static method in class org.erowid.sperowider.FileUtils
Gunzips a file to a file of the same name, minus .gz.
gunzip(File) - Static method in class org.erowid.sperowider.FileUtils
Gzips a file to a file of the same name, plus .gz.
gunzip(String, String) - Static method in class org.erowid.sperowider.FileUtils
Gzips to a file.
gunzip(String, File) - Static method in class org.erowid.sperowider.FileUtils
Gzips to a file.
gunzip(File, String) - Static method in class org.erowid.sperowider.FileUtils
Gzips to a file.
gunzip(File, File) - Static method in class org.erowid.sperowider.FileUtils
Gzips from one file to another.
gunzip(InputStream, OutputStream) - Static method in class org.erowid.sperowider.FileUtils
Gzips from the input stream to the output stream.
gzip(String) - Static method in class org.erowid.sperowider.FileUtils
Gzips a file to a file of the same name, plus .gz.
gzip(File) - Static method in class org.erowid.sperowider.FileUtils
Gzips a file to a file of the same name, plus .gz.
gzip(String, String) - Static method in class org.erowid.sperowider.FileUtils
Gzips to a file.
gzip(String, File) - Static method in class org.erowid.sperowider.FileUtils
Gzips to a file.
gzip(File, String) - Static method in class org.erowid.sperowider.FileUtils
Gzips to a file.
gzip(File, File) - Static method in class org.erowid.sperowider.FileUtils
Gzips from one file to another.
gzip(InputStream, OutputStream) - Static method in class org.erowid.sperowider.FileUtils
Gzips from the input stream to the output stream.

H

HREF - Static variable in class org.erowid.sperowider.htmlshredding.URLMongler
Indicates a URL found as an href attribute of a tag
HTMLComment - class org.erowid.sperowider.htmlshredding.HTMLComment.
Represents a comment in an HTML document
HTMLComment(String) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLComment
Creates a new HTMLComment object.
HTMLDocType - class org.erowid.sperowider.htmlshredding.HTMLDocType.
Represents a first, and fairly crude, whack at the doctype tag.
HTMLDocType(String) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLDocType
 
HTMLElement - interface org.erowid.sperowider.htmlshredding.HTMLElement.
Represents a generic element (comment, tag, etc) in an HTML document.
HTMLKeywordTag - class org.erowid.sperowider.htmlshredding.HTMLKeywordTag.
Represents an HTML meta tag that provides keywords for the document.
HTMLKeywordTag(String) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLKeywordTag
Initiated with the contents of the content attribute, *NOT* the full tag.
HTMLKeywordTag(HTMLTag) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLKeywordTag
Initialized with a more generic tag
HTMLMetaTag - class org.erowid.sperowider.htmlshredding.HTMLMetaTag.
Represents a MetaTag in an HTML doc.
HTMLMetaTag(String, String) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLMetaTag
Initialized only with the name and content text, and not the <, >, etc.
HTMLMetaTag(HTMLTag) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLMetaTag
Initialized with a more generic tag
HTMLShmongler - class org.erowid.sperowider.htmlshredding.HTMLShmongler.
Takes an InputStreamReader and and fires off a series of events (the foundHTMLxxxx() methods) in the order of HTMLElements found.
HTMLShmongler() - Constructor for class org.erowid.sperowider.htmlshredding.HTMLShmongler
Creates a new Shmongler.
HTMLShredder - class org.erowid.sperowider.htmlshredding.HTMLShredder.
Takes an InputStreamReader and turns the data so streamed into an ordered collection of HTML elements.
HTMLShredder() - Constructor for class org.erowid.sperowider.htmlshredding.HTMLShredder
Creates a new HTMLShredder
HTMLTag - class org.erowid.sperowider.htmlshredding.HTMLTag.
Represents a generic HTML Tag, which consists of a name, lead and following characters (for closing tags, or for self closing tags), and a collection of attributes, some of which have values.
HTMLTag(String) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLTag
This is instantiated with the tag name (the command at the start of the tag) *only*.
HTMLTag() - Constructor for class org.erowid.sperowider.htmlshredding.HTMLTag
Creates an empty tag
HTMLTagAttribute - class org.erowid.sperowider.htmlshredding.HTMLTagAttribute.
Represents a given attribute inside of an HTML tag.
HTMLTagAttribute(String) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLTagAttribute
Creates a new attribute with no value
HTMLTagAttribute(String, String) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLTagAttribute
Creates a new attribute with a value.
HTMLText - class org.erowid.sperowider.htmlshredding.HTMLText.
Represents a big ol' block of text in an HTML document.
HTMLText(String) - Constructor for class org.erowid.sperowider.htmlshredding.HTMLText
Creates a new chunk of HTML text
HandlerPool - class org.erowid.sperowider.HandlerPool.
A pool of AHandler objects, and a map from MIME types and file extensions to those objects.
HandlerPool(SperowiderContext) - Constructor for class org.erowid.sperowider.HandlerPool
Creates a new HandlerPool object, and creates some basic mappings : text/html maps to TextHtmlHandler text/css maps to TextCssHandler application/x-javascript maps to PatternMatchingHandler .html maps to TextHtmlHandler .css maps to TextCssHandler .js maps to PatternMatchingHandler It also creates the default handler, which is used for unrecognized MIME types and file extensions.
HtmlGeneratingSperowiderModelReporter - class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter.
Logs to a set of summary files.
HtmlGeneratingSperowiderModelReporter() - Constructor for class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
 
handleConnection(String, HttpURLConnection) - Method in class org.erowid.sperowider.ASpiderBase
When a connection is actually established, this method will be called.
handleConnection(String, HttpURLConnection) - Method in class org.erowid.sperowider.Downloader
Delegates to the appropriate AHandler.
handleConnection(String, HttpURLConnection) - Method in class org.erowid.sperowider.simple.SimplePageSpider
Loads HTML page, parses for links, indexes.
handleConnectionException(String, Throwable) - Method in class org.erowid.sperowider.ASpiderBase
This is called by ASpiderBase.spider(String) when an exception is found when an attempt to load the URL is hit.
handleConnectionException(String, Throwable) - Method in class org.erowid.sperowider.Downloader
IO exceptions get marked as invalid URLs.
handleConnectionException(String, Throwable) - Method in class org.erowid.sperowider.simple.SimplePageSpider
Logs error.
hasDocs() - Method in class org.erowid.masterdoc.InternalRepository
Returns true if there are document directories for this entry.
hasGeneralUrl() - Method in class org.erowid.masterdoc.Repository
Returns true if this repository has a valid general URL.
hasSource() - Method in class org.erowid.masterdoc.InternalRepository
Returns true if there is source code for this repository (and therefore an API should be generated).

I

IConfigurator - interface org.erowid.sperowider.configuration.IConfigurator.
Sperowider instantiators need to implement this method.
IDownloadFilter - interface org.erowid.sperowider.urlfilter.IDownloadFilter.
A filter for indicating if a Url should be downloaded.
IIndexFilter - interface org.erowid.sperowider.urlfilter.IIndexFilter.
Indicates if a Url or filename should be indexed
IInitializableObject - interface org.erowid.sperowider.IInitializableObject.
Objects that can get automatically instantiated by config implement this.
INDEX - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.INDEX_LOGNAME
INDEX_ERROR - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.INDEX_ERROR_LOGNAME
INDEX_ERROR_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "index.error" in the log4j configuration to indicate the logger that is used to show indexing errors.
INDEX_INDEX - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.INDEX_INDEX_LOGNAME
INDEX_INDEX_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "index.index" in the log4j configuration to indicate the logger that is used to show when a document is indexed.
INDEX_LIMIT - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Configuration corresponding to SperowiderContext.getIndexLimit().
INDEX_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "index" in the log4j configuration file to indicate all of the indexing loggers.
ISimpleSpiderFilter - interface org.erowid.sperowider.simple.ISimpleSpiderFilter.
A convenience interface to combine all filters required for SimpleSpider.
ISimpleSpiderModel - interface org.erowid.sperowider.simple.ISimpleSpiderModel.
The interface for the model that the SimpleSpider uses.
ISperowiderFilter - interface org.erowid.sperowider.urlfilter.ISperowiderFilter.
A convenience interface that wraps all required Sperowider filter interfaces.
ISperowiderModel - interface org.erowid.sperowider.ISperowiderModel.
This interface defines the core model for data tracking.
ISperowiderModelReporter - interface org.erowid.sperowider.modelreporting.ISperowiderModelReporter.
The reporting interface for ISperowiderModel.
ISpiderFilter - interface org.erowid.sperowider.urlfilter.ISpiderFilter.
A filtering for spidering urls found in webpages.
IThrottle - interface org.erowid.sperowider.IThrottle.
The interface for ensuring that file downloads do not happen too rapidly.
Indexer - class org.erowid.sperowider.Indexer.
Even though it would be more efficient to do this as part of rectification, I'm breaking this out so it can be run stand-alone.
Indexer(SperowiderContext) - Constructor for class org.erowid.sperowider.Indexer
Creates a new Indexer, a class that creates a Lucene index for a tree of already downloaded and rectified files.
IndexerRunner - class org.erowid.sperowider.IndexerRunner.
Runs the Sperowider indexing.
IndexerRunner(SperowiderContext) - Constructor for class org.erowid.sperowider.IndexerRunner
Creates a runner to run an Indexer.
InternalRepository - class org.erowid.masterdoc.InternalRepository.
The settings for APIs that are to be generated.
InternalRepository(String, String, String, String) - Constructor for class org.erowid.masterdoc.InternalRepository
 
index(String) - Method in class org.erowid.sperowider.Indexer
Creates a new Document for the passed in file, and adds it to the index.
indexMatch(String) - Method in class org.erowid.masterdoc.MasterDocFilter
Must match on include and not match on exclude.
indexMatch(String) - Method in class org.erowid.sperowider.urlfilter.ADumbIndexFilter
Returns true if the file ends in html.
indexMatch(String) - Method in class org.erowid.sperowider.urlfilter.BlocksAllFilter
Returns false
indexMatch(String) - Method in interface org.erowid.sperowider.urlfilter.IIndexFilter
Returns true if the URL or filename (in the case of the Sperowider) should be indexed.
init() - Method in class org.erowid.sperosearch.SearcherApplet
Automatically called by the Java Plugin, this initializes the applet UI and instantiates the search engine.
init(Element) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
init(Element) - Method in interface org.erowid.sperowider.IInitializableObject
Initiale this class with the passed in XML configuration element.
init(String, boolean, boolean, String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
Initializes this model, with default reporters.
init(Element) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
Initializes this SperowiderModel with a configuration.
init(Element) - Method in class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
Initializes the location of the files.
init(Element) - Method in class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
Initializes the location of the files.
init(Element) - Method in class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
Delegated to by extending classes, this configures what reporters are used by this class.
init(Element) - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Initializes this SimpleURLFilter with a JDOM element that has an include and exclude pattern list.
init(Element) - Method in class org.erowid.sperowider.urlfilter.BlocksAllFilter
Does nothing
init(Element) - Method in class org.erowid.sperowider.urlfilter.NoHopRegexSperowiderFilter
Implements filter config
init(Element) - Method in class org.erowid.sperowider.urlfilter.NoHopSimpleSperowiderFilter
Implements filter config
init(Element) - Method in class org.erowid.sperowider.urlfilter.OneHopRegexSperowiderFilter
Implements filter config
init(Element) - Method in class org.erowid.sperowider.urlfilter.OneHopSimpleSperowiderFilter
Implements filter config
init(Element) - Method in class org.erowid.sperowider.urlfilter.URLFilter
Deprecated. Issues a deprecation warning and then delegates to NoHopSimpleSperowiderFilter.init(Element)
initObject(Element) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
Given a configuration, will return an object that has had IInitializableObject.init(Element) called on it.
insertHTMLElement(HTMLElement, int) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Inserts a new HTML element before the element at the given position, and moves all others to the right.
insertHTMLShredder(HTMLShredder, int) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Inserts the contents of an HTML Shredder before the element at the given position, and moves all others to the right.
instantiate(SperowiderConfiguration, Document, String) - Method in interface org.erowid.sperowider.configuration.IConfigurator
This will create a Sperowider based on the named target in the config document.
instantiate(SperowiderConfiguration, InputStream) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
Delegates to SperowiderConfigurator.instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).
instantiate(SperowiderConfiguration, InputStream, String) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
Delegates to SperowiderConfigurator.instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).
instantiate(SperowiderConfiguration, String) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
Delegates to SperowiderConfigurator.instantiate(SperowiderConfiguration, String, String) with a null target, returning a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration).
instantiate(SperowiderConfiguration, String, String) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
Returns a SperowiderConfiguration suitable for use in Sperowider.Sperowider(SperowiderConfiguration), using the named file, with the named target.
instantiate(SperowiderConfiguration, Document) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
Delegates to instantiate(configDoc, null).
instantiate(SperowiderConfiguration, Document, String) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
This will create a SperowiderConfiguration based on the named target in the config document.
instantiateLog4j(String) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
Sets up log4j with the given filename.
instantiateLog4j(InputStream) - Static method in class org.erowid.sperowider.configuration.SperowiderConfigurator
Sets up log4j with a given InputStream.
isAtEnd() - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns true if the read position is past the end of the data
isCommand() - Method in class org.erowid.sperowider.SperowiderCommandInterpreter
Returns true if the most recently parsed command text was an actual command, or just a regular comment.
isCompressIndex() - Method in class org.erowid.sperowider.SperowiderContext
Returns the compressIndex.
isExcludeEnd() - Method in class org.erowid.sperowider.SperowiderCommandInterpreter
Returns true if the most recently parsed command text was an exclude-end command.
isExcludeStart() - Method in class org.erowid.sperowider.SperowiderCommandInterpreter
Returns true if the most recently parsed command text was an exclude-start command.
isGenerateApi() - Method in class org.erowid.masterdoc.MasterRepository
Returns the generateAPI.
isGenerateDocs() - Method in class org.erowid.masterdoc.MasterRepository
Returns true if the docbase should be generated
isGenerateSearch() - Method in class org.erowid.masterdoc.MasterRepository
Returns true if the searchbase should be generated
isInclude() - Method in class org.erowid.sperowider.SperowiderCommandInterpreter
Returns true if the most recently parsed command text was an include command.
isIncludeApiInSearch() - Method in class org.erowid.masterdoc.MasterRepository
 
isIncludeDocsInSearch() - Method in class org.erowid.masterdoc.MasterRepository
 
isInitGood() - Method in class org.erowid.sperosearch.SearcherApplet
Returns true if initialization has succeeded
isInitOver() - Method in class org.erowid.sperosearch.SearcherApplet
Returns true if initialization is complete.
isInitialized() - Method in class org.erowid.sperowider.SperowiderContext
Returns true if all sets have been called appropriately.
isNoIndex() - Method in class org.erowid.sperowider.SperowiderCommandInterpreter
Returns true if a noindex tag was found.
isSearchGood() - Method in class org.erowid.sperosearch.SearcherApplet
Returns true if the applet wasn't interrupted by an exception the last time SearcherApplet.search(String) was called.
isSearchOver() - Method in class org.erowid.sperosearch.SearcherApplet
Returns true if the applet is done searching, whether the search was successful or ended in an error.
isSingletonAttribute() - Method in class org.erowid.sperowider.htmlshredding.HTMLTagAttribute
Returns true if this tag has no value.
isSpiderMapSupported() - Method in class org.erowid.sperowider.BasicSperowiderModel
Returns false, because the BasicSperowiderModel does not support BasicSperowiderModel.getFoundURLs(String) or BasicSperowiderModel.getSourceURLs(String).
isSpiderMapSupported() - Method in interface org.erowid.sperowider.ISperowiderModel
Implementing classes should return true if they are capable of handling calls to ISperowiderModel.getSourceURLs(String) and ISperowiderModel.getFoundURLs(String), false otherwise.
isSpiderMapSupported() - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
This model does support SperowiderModel.getFoundURLs(String) and SperowiderModel.getSourceURLs(String), so this method can return true, if "support-spider-map" is set to true in the model declaration of the config file.
isSpiderMapSupported() - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
Implementing classes should return true if they are capable of handling calls to ISimpleSpiderModel.getSourceURLs(String) and ISimpleSpiderModel.getFoundURLs(String), false otherwise.
isSpiderMapSupported() - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
Returns false always, as SimpleSpiderModel.getSourceURLs(String) and SimpleSpiderModel.getFoundURLs(String) are not supported in this model.
isUseDefaultDependencies() - Method in class org.erowid.masterdoc.InternalRepository
Returns true if no dependencies have been set.
isUseReplacementPattern() - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
This returns true if the replacement pattern should be used to replace found URLs.
isValid() - Method in class org.erowid.sperowider.configuration.Configuration
Returns true if all required settings have been set by calling Configuration.set(String, Object) or Configuration.setUnlessSet(String, Object), or have defaults.

J

JAVASCRIPT_EVENT - Static variable in class org.erowid.sperowider.htmlshredding.URLMongler
Indicates a URL found as an action attribute of a tag
jumpTo(int) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Jumps to a position

L

LIMIT - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Limit setting name.
LOGGING_CONFIGURATION_FILE - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Configuration logging configuration setting name.
LoggingSperowiderModelReporter - class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter.
Logs to a set of summary files.
LoggingSperowiderModelReporter() - Constructor for class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
 
list() - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Http can't really support this.
listFiles() - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Lists the filenames of all files.
loadDescriptor() - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Loads this directory descriptor.

M

MEMORY - Static variable in class org.erowid.sperowider.hsqldb.BasicTable
Used in constructors to indicate that all data should be stored in memory.
MINIMUM_THROTTLE - Static variable in class org.erowid.sperowider.Sperowider
The system won't allow a smaller throttle than 100.
MODEL - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Model setting name.
Main - class org.erowid.masterdoc.Main.
Runner for Masterdoc.
Main() - Constructor for class org.erowid.masterdoc.Main
 
MapTable - class org.erowid.sperowider.hsqldb.MapTable.
This class presents some Map-like functionality wrapped around an HSQLDB table.
MapTable(String, Connection, int) - Constructor for class org.erowid.sperowider.hsqldb.MapTable
Constructor, gets everything ready for usage.
MasterDocConfigurator - class org.erowid.masterdoc.MasterDocConfigurator.
Given a config file, returns a MasterRepository.
MasterDocConfigurator() - Constructor for class org.erowid.masterdoc.MasterDocConfigurator
 
MasterDocFilter - class org.erowid.masterdoc.MasterDocFilter.
Masterdoc file filter for indexing, spidering.
MasterDocFilter(String, String) - Constructor for class org.erowid.masterdoc.MasterDocFilter
Sets up index and spider filters.
MasterRepository - class org.erowid.masterdoc.MasterRepository.
The API to generate.
MasterRepository(String, String, String) - Constructor for class org.erowid.masterdoc.MasterRepository
 
MongledURLType - class org.erowid.sperowider.htmlshredding.MongledURLType.
Represents the type of URL mongled
MongledURLType(String) - Constructor for class org.erowid.sperowider.htmlshredding.MongledURLType
Creates a new URLType
main(String[]) - Static method in class org.erowid.masterdoc.Main
Generates a masterdoc using the name of the file passed in via the arguments.
main(String[]) - Static method in class org.erowid.sperowider.SperowiderRunner
The main entry point for external execution of the Sperowider.
main(String[]) - Static method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Tests.
makeLock(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Returns a dummy lock object.
map(String) - Method in class org.erowid.sperowider.hsqldb.MapTable
Returns the value mapped to this key.
map(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
A weird outlier of a method, this provides the same functionality as MapTable.map(String), allowing this to be used as a simple map.
mapFirst(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Returns the second values mapped to this first value.
mapFoundURLToRealURL(String, String) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
mapFoundURLToRealURL(String, String) - Method in interface org.erowid.sperowider.ISperowiderModel
Maps a found URL to a "real URL".
mapFoundURLToRealURL(String, String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
mapRealURLToFileName(String, String) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
mapRealURLToFileName(String, String) - Method in interface org.erowid.sperowider.ISperowiderModel
Maps a "real" URL to a file name.
mapRealURLToFileName(String, String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
mapSecond(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Returns the first values mapped to this second value.
mark(int) - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
 
markInvalidURL(String, int, String) - Method in class org.erowid.sperowider.BasicSperowiderModel
 
markInvalidURL(String, int, String) - Method in interface org.erowid.sperowider.ISperowiderModel
Mark a URL as invalid
markInvalidURL(String, int, String) - Method in class org.erowid.sperowider.hsqldb.SperowiderModel
 
markInvalidURL(String, int, String) - Method in interface org.erowid.sperowider.simple.ISimpleSpiderModel
Mark a URL as invalid
markInvalidURL(String, int, String) - Method in class org.erowid.sperowider.simple.SimpleSpiderModel
Marks a URL as bad
markSupported() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
 
matchAny(List, String) - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Returns true if url matches any of the patterns in the list.
matchAny(List, String) - Static method in class org.erowid.sperowider.urlfilter.PatternMatcher
Returns true if url matches any of the patterns in the list.
matchAny(List, String) - Method in class org.erowid.sperowider.urlfilter.RegexFilter
Returns true if any of the pattern in the passed in list match the passed in name
matchAny(List, String) - Method in class org.erowid.sperowider.urlfilter.SimpleFilter
Returns true if any of the pattern in the passed in list match the passed in url
matchAny(List, String) - Static method in class org.erowid.sperowider.urlfilter.SimpleMatcher
Performs a simple match, as described in the class doc.
matchExcludes(String) - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Returns true if any in the includes list is matched
matchIncludes(String) - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Returns true if any in the includes list is matched
mongle(URL) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader) and/or AMongler.mongle(BufferedReader, Writer).
mongle(String) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader) and/or AMongler.mongle(BufferedReader, Writer).
mongle(File) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader) and/or AMongler.mongle(BufferedReader, Writer).
mongle(InputStream) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader) and/or AMongler.mongle(BufferedReader, Writer).
mongle(URL, Writer) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader) and/or AMongler.mongle(BufferedReader, Writer).
mongle(String, Writer) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader) and/or AMongler.mongle(BufferedReader, Writer).
mongle(File, Writer) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader) and/or AMongler.mongle(BufferedReader, Writer).
mongle(InputStream, Writer) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader) and/or AMongler.mongle(BufferedReader, Writer).
mongle(BufferedReader) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader, Writer).
mongle(BufferedReader, Writer) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Delegates to AMongler.mongle(BufferedReader).
mongle(BufferedReader, Writer) - Method in class org.erowid.sperowider.htmlshredding.CSSURLMongler
 
mongle(BufferedReader) - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
Looks for URLs using the passed in pattern.
mongle(URL) - Method in class org.erowid.sperowider.htmlshredding.URLMongler
Delegates to URLMongler.mongle(HTMLShredder).
mongle(String) - Method in class org.erowid.sperowider.htmlshredding.URLMongler
Delegates to URLMongler.mongle(HTMLShredder).
mongle(File) - Method in class org.erowid.sperowider.htmlshredding.URLMongler
Delegates to URLMongler.mongle(HTMLShredder).
mongle(InputStream) - Method in class org.erowid.sperowider.htmlshredding.URLMongler
Delegates to URLMongler.mongle(HTMLShredder).
mongle(BufferedReader) - Method in class org.erowid.sperowider.htmlshredding.URLMongler
Delegates to URLMongler.mongle(HTMLShredder).
mongle(HTMLShredder) - Method in class org.erowid.sperowider.htmlshredding.URLMongler
Calls URLMongler.urlFound(String, MongledURLType) whenever a URL is found, and replaces it with the value returned by that method.

N

NON_THROTTLE - Static variable in class org.erowid.sperowider.NonThrottle
A static instance of IThrottle that does no throttling.
NoHopRegexSperowiderFilter - class org.erowid.sperowider.urlfilter.NoHopRegexSperowiderFilter.
This class functions as filter to implement No-Hop logic using Regex for downloading and spidering.
NoHopRegexSperowiderFilter() - Constructor for class org.erowid.sperowider.urlfilter.NoHopRegexSperowiderFilter
 
NoHopSimpleSperowiderFilter - class org.erowid.sperowider.urlfilter.NoHopSimpleSperowiderFilter.
This class functions as filter to implement No-Hop logic using Regex for downloading and spidering.
NoHopSimpleSperowiderFilter() - Constructor for class org.erowid.sperowider.urlfilter.NoHopSimpleSperowiderFilter
 
NonThrottle - class org.erowid.sperowider.NonThrottle.
A concrete implementation of IThrottle that does not ever block.
NonThrottle() - Constructor for class org.erowid.sperowider.NonThrottle
 
nextCharactersMatch(char[], boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns true if the next characters match the passed in parameter, without adjusting the current position.
nextCharactersMatch(char[]) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns true if the next characters match the passed in parameter, without adjusting the current position.

O

OPTION - Static variable in class org.erowid.sperowider.htmlshredding.URLMongler
Indicates a URL found as a value of an option tag
OneHopRegexSperowiderFilter - class org.erowid.sperowider.urlfilter.OneHopRegexSperowiderFilter.
This class functions as filter to implement One-Hop logic using Regex for downloading and spidering.
OneHopRegexSperowiderFilter() - Constructor for class org.erowid.sperowider.urlfilter.OneHopRegexSperowiderFilter
 
OneHopSimpleSperowiderFilter - class org.erowid.sperowider.urlfilter.OneHopSimpleSperowiderFilter.
This class functions as filter to implement One-Hop logic using Regex for downloading and spidering.
OneHopSimpleSperowiderFilter() - Constructor for class org.erowid.sperowider.urlfilter.OneHopSimpleSperowiderFilter
 
openFile(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Returns a InputStream that pipes in the data for the requested file.
org.erowid.masterdoc - package org.erowid.masterdoc
Masterdoc is designed to create an enterprise Javadoc site, with multiple local Javadoc repositories each cross-linked, along with references to useful external repositories.
org.erowid.sperosearch - package org.erowid.sperosearch
The applet (and supporting classes) that provides search functionality against the search index generated by Sperowider, during its index phase.
org.erowid.sperosearch.splitindex - package org.erowid.sperosearch.splitindex
Takes one or more files in a directory that have been split into equally sized segments and gzip compressed, and presents them for reading via an input stream.
org.erowid.sperowider - package org.erowid.sperowider
Provides the core Sperowider functionality of downloading, spidering, rectifying, and indexing (for the SperoSearch applet) a website.
org.erowid.sperowider.configuration - package org.erowid.sperowider.configuration
The configuration, default configuration, and CLI override model for Sperowider.
org.erowid.sperowider.hsqldb - package org.erowid.sperowider.hsqldb
Provides a Hypersonic SQL backed ISperowiderModel.
org.erowid.sperowider.htmlshredding - package org.erowid.sperowider.htmlshredding
Provides HTML shredding (taking an HTML file and breaking it into individual elements) and URL mongling (throwing events when URLs are found, and providing an opportunity to replace them) functionality.
org.erowid.sperowider.modelreporting - package org.erowid.sperowider.modelreporting
Configurable hook model for intercepting and reporting on Sperowider events.
org.erowid.sperowider.simple - package org.erowid.sperowider.simple
A simple, lightweight spider that uses Sperowider core technology to walk a website and create a search index.
org.erowid.sperowider.urlfilter - package org.erowid.sperowider.urlfilter
URL filter intefaces and implementations to allow for control over Simple Spider spidering decisions, and Sperowider spidering, rectifying, downloading, and indexing decisions.

P

PRIMING_URLS - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Priming URLs setting name.
PatternMatcher - class org.erowid.sperowider.urlfilter.PatternMatcher.
Does Regex style pattern matching in support of regex based URL filters like RegexFilter.
PatternMatcher() - Constructor for class org.erowid.sperowider.urlfilter.PatternMatcher
 
PatternMatchingHandler - class org.erowid.sperowider.PatternMatchingHandler.
Uses the contents of a Sperowider custom tag inside of the passed in file to identify a regex pattern as the mongling policy.
PatternMatchingHandler() - Constructor for class org.erowid.sperowider.PatternMatchingHandler
 
PatternMatchingMongler - class org.erowid.sperowider.htmlshredding.PatternMatchingMongler.
Uses pattern matching to perform mongling.
PatternMatchingMongler() - Constructor for class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
 
prepareStatement(String) - Method in class org.erowid.sperowider.hsqldb.BasicTable
A convenience method to prepare a SQL statement.
process() - Method in class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor
Does the splitting, zipping, deleting, and then saves the descriptor file.
process() - Method in class org.erowid.sperosearch.splitindex.WriteableSplitIndexFileDescriptor
Splits and compresses this file.

R

RECTIFY - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.RECTIFY_LOGNAME
RECTIFY_DOCUMENT - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.RECTIFY_DOCUMENT_LOGNAME
RECTIFY_DOCUMENT_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "rectify.document" in the log4j configuration to indicate the logger that is used to show when a document is rectified.
RECTIFY_ERROR - Static variable in class org.erowid.sperowider.SperoLog
The logger corresponding to SperoLog.RECTIFY_ERROR_LOGNAME
RECTIFY_ERROR_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "rectify.error" in the log4j configuration to indicate the logger that is used to show rectifcation errors.
RECTIFY_LOGNAME - Static variable in class org.erowid.sperowider.SperoLog
Use "rectify" in the log4j configuration file to indicate all of the rectification loggers.
RawHtmlData - class org.erowid.sperowider.htmlshredding.RawHtmlData.
Convenience class to allow easy parsing of found data.
RawHtmlData(Reader) - Constructor for class org.erowid.sperowider.htmlshredding.RawHtmlData
Creates a new RawHtmlData object from the Reader
RawHtmlData(InputStream) - Constructor for class org.erowid.sperowider.htmlshredding.RawHtmlData
Creates a new RawHtmlData object from the InputStream
RawHtmlData(String) - Constructor for class org.erowid.sperowider.htmlshredding.RawHtmlData
Creates a new RawHtmlData object from a String
Rectifier - class org.erowid.sperowider.Rectifier.
Once the files are downloaded, the rectifier does a second pass and converts all of the URLs to local URLs, flattening redirects, making them all relative, etc.
Rectifier(SperowiderContext) - Constructor for class org.erowid.sperowider.Rectifier
Creates a new Rectifier, that uses AHandler objects from the HandlerPool to rectify a file.
RectifierRunner - class org.erowid.sperowider.RectifierRunner.
Loops the the files to be rectified, and rectifies them using Rectifier objects.
RectifierRunner(SperowiderContext) - Constructor for class org.erowid.sperowider.RectifierRunner
Creates a new RectifierRunner
RegexFilter - class org.erowid.sperowider.urlfilter.RegexFilter.
A regex based implementation of AIncludeExcludeFilter.
RegexFilter() - Constructor for class org.erowid.sperowider.urlfilter.RegexFilter
 
RegexURLFilter - class org.erowid.sperowider.urlfilter.RegexURLFilter.
Deprecated. Use NoHopRegexSperowiderFilter instead of this class.
RegexURLFilter() - Constructor for class org.erowid.sperowider.urlfilter.RegexURLFilter
Deprecated. Delegates to super constructor, and then logs informational message.
Repository - class org.erowid.masterdoc.Repository.
A Javadoc API.
Repository(String, String, String) - Constructor for class org.erowid.masterdoc.Repository
Default constructor.
read() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
 
read() - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns the next character as an int, or -1 if there are no characters left to read.
read(int) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns from the current position to the length provided
readInternal(byte[], int, int) - Method in class org.erowid.sperosearch.splitindex.SplitIndexLuceneInputStream
 
readPast(char, boolean, boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads up to, and including, the match character
readPast(char, boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads up to, and including, the match character
readPast(char[], boolean, boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads up to, and including, the match characters
readPast(char[], boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads up to, and including, the match characters
readPastWhitespace() - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns the first non-whitespace character
readTo(int) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Returns from the current position to the position provided
readUntil(char, boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads up to, but not including the match character
readUntil(char) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads up to, but not including the match character
readUntil(char[], boolean) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads up to, but not including the match characters
readUntil(char[]) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads up to, but not including the match characters
readWhitespace() - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Reads until we're done with whitespace
rectify(String) - Method in class org.erowid.sperowider.AHandler
This method is responsible for parsing the local file, and rewriting it as appropriate, typically replacing all URLs with relative local file references
rectify(String) - Method in class org.erowid.sperowider.GenericHandler
Does nothing.
rectify(String) - Method in class org.erowid.sperowider.PatternMatchingHandler
See PatternMatchingHandler.download(HttpURLConnection, String, String) to see how URLs are rectified using this handler.
rectify(String) - Method in class org.erowid.sperowider.Rectifier
Rectify a given file on the local filesystem.
rectify(String) - Method in class org.erowid.sperowider.TextCssHandler
Rectifies found URLs.
rectify(String) - Method in class org.erowid.sperowider.TextHtmlHandler
Replaces URLs found in text/html files with local file references.
remove(String) - Method in class org.erowid.sperowider.hsqldb.MapTable
Removes the mapping corresponding to this key.
remove(String) - Method in class org.erowid.sperowider.hsqldb.SetTable
Removes a value from this set.
remove() - Method in class org.erowid.sperowider.hsqldb.SetTable
Chooses an arbitrary value in this list, removes it from the list, and returns it.
remove(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Removes all mappings where the passed in value is either column
remove(String, String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Removes the mappings from the passed in first value to the passed in second value.
removeFirst(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Removes all mappings where the passed in value is in the first column
removeKeyword(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLKeywordTag
Removes a keyword
removeSecond(String) - Method in class org.erowid.sperowider.hsqldb.TwoWayMapTable
Removes all mappings where the passed in value is in the second column
renameFile(String, String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Does nothing, because this is a read only directory.
reportInvalidUrlFound(String, int, String) - Method in class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
Adds a line to the invalid URL file.
reportInvalidUrlFound(String, int, String) - Method in interface org.erowid.sperowider.modelreporting.ISperowiderModelReporter
Called when an invalid URL is found
reportInvalidUrlFound(String, int, String) - Method in class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
Logs to SperoLog.DOWNLOAD_INVALIDURL in the format <invalid-url url="" code="" message="" />.
reportInvalidUrlFound(String, int, String) - Method in class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
Delegates to child ISperowiderModelReporter objects.
reportMapUrlToFilename(String, String) - Method in class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
Does nothing
reportMapUrlToFilename(String, String) - Method in interface org.erowid.sperowider.modelreporting.ISperowiderModelReporter
Called when a URL has been mapped to a local filename.
reportMapUrlToFilename(String, String) - Method in class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
Logs to SperoLog.DOWNLOAD_URLMAP in the format <url-map real-url="" file-name="" />.
reportMapUrlToFilename(String, String) - Method in class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
Delegates to child ISperowiderModelReporter objects.
reportMapUrlToRealUrl(String, String) - Method in class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
Does nothing
reportMapUrlToRealUrl(String, String) - Method in interface org.erowid.sperowider.modelreporting.ISperowiderModelReporter
Called when a URL has been mapped to its final, real form.
reportMapUrlToRealUrl(String, String) - Method in class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
Logs to SperoLog.DOWNLOAD_URLMAP in the format <url-map found-url="" real-url="" />.
reportMapUrlToRealUrl(String, String) - Method in class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
Delegates to child ISperowiderModelReporter objects.
reportOnDownload(ISperowiderModel, DownloadRunner, Date, Date) - Method in class org.erowid.sperowider.SummaryReportGenerator
Generates a download report to the log.
reportOnIndex(ISperowiderModel, IndexerRunner, Date, Date) - Method in class org.erowid.sperowider.SummaryReportGenerator
Generates a indexer report to the log.
reportOnRectify(ISperowiderModel, RectifierRunner, Date, Date) - Method in class org.erowid.sperowider.SummaryReportGenerator
Generates a indexer report to the log.
reportOnStatus(ISperowiderModel) - Method in class org.erowid.sperowider.SummaryReportGenerator
Generates a indexer report to the log.
reportUrlFound(String, String, String) - Method in class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
Does nothing
reportUrlFound(String, String, String) - Method in interface org.erowid.sperowider.modelreporting.ISperowiderModelReporter
Called when one URL has been found in the page found at another URL, and logs a message indicating how/if it was queued.
reportUrlFound(String, String, String) - Method in class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
Logs to SperoLog.DOWNLOAD_URLFOUND in the format <url-found source-url="" found-url="" queued="" />
reportUrlFound(String, String, String) - Method in class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
Delegates to child ISperowiderModelReporter objects.
reportUrlPoppedFromQueue(String) - Method in class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
Does nothing
reportUrlPoppedFromQueue(String) - Method in interface org.erowid.sperowider.modelreporting.ISperowiderModelReporter
Called when a URL has been popped from the queue.
reportUrlPoppedFromQueue(String) - Method in class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
Logs to SperoLog.DOWNLOAD_URLPOPFROMQUEUE in the format <url-queue-pop url="" />.
reportUrlPoppedFromQueue(String) - Method in class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
Delegates to child ISperowiderModelReporter objects.
reset() - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
 
run() - Method in class org.erowid.sperowider.DownloadRunner
Starts downloading and spidering, with the passed in URL as the first URL.
run() - Method in class org.erowid.sperowider.IndexerRunner
Indexes all downloaded files in the source tree that the downloader has marked as for indexing.
run() - Method in class org.erowid.sperowider.RectifierRunner
Loops the the files to be rectified, and rectifies them using Rectifier objects, until no files are left.
run() - Method in class org.erowid.sperowider.Sperowider
Downloads, spiders, rectifies, and indexes based on the previous calls to the various setters and Sperowider.setShouldDownload(boolean), and Sperowider.setShouldIndex(boolean) and Sperowider.setShouldRectify(boolean).
run(String, String, String[]) - Method in class org.erowid.sperowider.SperowiderRunner
Configures and runs a Sperowider.

S

SERVLET - Static variable in class org.erowid.masterdoc.MasterRepository
Servlet search engine, for MasterRepository.setSearchEngineType(String).
SHOULD_DOWNLOAD - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Should download setting name.
SHOULD_INDEX - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Should index setting name.
SHOULD_RECTIFY - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Should rectify setting name.
SPEROWIDER_USER_AGENT - Static variable in class org.erowid.sperowider.ASpiderBase
The actual user agent sent to websites : "Sperowider/1.1"
SPEROWIDER_USER_AGENT_NAME - Static variable in class org.erowid.sperowider.ASpiderBase
The name of the user agent, without the version number : "Sperowider"
SPEROWIDER_USER_AGENT_VERSION - Static variable in class org.erowid.sperowider.ASpiderBase
The current version number of the Sperowider : "1.1"
SRC - Static variable in class org.erowid.sperowider.htmlshredding.URLMongler
Indicates a URL found as a src attribute of a tag
SUCCESS - Static variable in class org.erowid.sperowider.ASpiderBase
Returned by ASpiderBase.spider(String) to indicate that the download succeeded.
SUMMARY_FILE_NAME - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Summary file name setting name.
SUMMARY_FOOTER_NAME - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Summary file footer insert setting name.
SUMMARY_HEADER_NAME - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Summary file footer insert setting name.
ScriptTag - class org.erowid.sperowider.htmlshredding.ScriptTag.
Represents an embedded script inside an HTML document.
ScriptTag(HTMLTag, String) - Constructor for class org.erowid.sperowider.htmlshredding.ScriptTag
The passed in parameter should not include the <script></script> tags.
SearchIndexReader - class org.erowid.sperosearch.SearchIndexReader.
Executes an actual search query over the generated search index.
SearchIndexReader(URL) - Constructor for class org.erowid.sperosearch.SearchIndexReader
Creates a new searcher for the Lucene searchbase located at the passed in URL.
SearchResultEntry - class org.erowid.sperosearch.SearchResultEntry.
An entry returned by the SperoSearch search engine.
SearchResultEntry(String, String, String, float) - Constructor for class org.erowid.sperosearch.SearchResultEntry
Creates a new SearchResultEntry for a SearchResults collection.
SearchResults - class org.erowid.sperosearch.SearchResults.
A set of SearchResultEntry objects, generated by a call to SearchIndexReader.search(String).
SearchResults() - Constructor for class org.erowid.sperosearch.SearchResults
 
SearcherApplet - class org.erowid.sperosearch.SearcherApplet.
Description: Provides searching functionality to web pages.
SearcherApplet() - Constructor for class org.erowid.sperosearch.SearcherApplet
 
SetTable - class org.erowid.sperowider.hsqldb.SetTable.
This class presents some Set-like functionality wrapped around an HSQLDB table.
SetTable(String, Connection, int) - Constructor for class org.erowid.sperowider.hsqldb.SetTable
Constructor, gets everything ready for usage.
SettingDoesNotExistException - exception org.erowid.sperowider.configuration.SettingDoesNotExistException.
Thrown by the various methods in Configuration if a request setting has not been created.
SettingDoesNotExistException() - Constructor for class org.erowid.sperowider.configuration.SettingDoesNotExistException
Standard constructor
SettingDoesNotExistException(String) - Constructor for class org.erowid.sperowider.configuration.SettingDoesNotExistException
Standard constructor
SettingDoesNotExistException(Throwable) - Constructor for class org.erowid.sperowider.configuration.SettingDoesNotExistException
Standard constructor
SettingDoesNotExistException(String, Throwable) - Constructor for class org.erowid.sperowider.configuration.SettingDoesNotExistException
Standard constructor
SimpleFilter - class org.erowid.sperowider.urlfilter.SimpleFilter.
An implementation of AIncludeExcludeFilter that uses the filter rules from SimpleMatcher.
SimpleFilter() - Constructor for class org.erowid.sperowider.urlfilter.SimpleFilter
 
SimpleMatcher - class org.erowid.sperowider.urlfilter.SimpleMatcher.
Does simple style pattern matching in support of simple based URL filters like SimpleFilter.
SimpleMatcher() - Constructor for class org.erowid.sperowider.urlfilter.SimpleMatcher
 
SimplePageSpider - class org.erowid.sperowider.simple.SimplePageSpider.
Takes an HTML location, indexes it, grabs the list of URLs.
SimplePageSpider(ISimpleSpiderModel, ISimpleSpiderFilter, IndexWriter) - Constructor for class org.erowid.sperowider.simple.SimplePageSpider
Constructs a page handler with a given data store.
SimpleSpider - class org.erowid.sperowider.simple.SimpleSpider.
Spiders a site, based on a given SimpleSpiderModel.
SimpleSpider(ISimpleSpiderModel, ISimpleSpiderFilter, File) - Constructor for class org.erowid.sperowider.simple.SimpleSpider
Creates a new spider based on a given model.
SimpleSpiderModel - class org.erowid.sperowider.simple.SimpleSpiderModel.
Interface to our data storage.
SimpleSpiderModel() - Constructor for class org.erowid.sperowider.simple.SimpleSpiderModel
Default constructor
SimpleURLFilter - class org.erowid.sperowider.urlfilter.SimpleURLFilter.
Deprecated. Use NoHopSimpleSperowiderFilter instead of this class.
SimpleURLFilter() - Constructor for class org.erowid.sperowider.urlfilter.SimpleURLFilter
Deprecated. Delegates to super constructor, and then logs informational message.
SperoLog - class org.erowid.sperowider.SperoLog.
Centralized logging location.
SperoLog() - Constructor for class org.erowid.sperowider.SperoLog
 
Sperowider - class org.erowid.sperowider.Sperowider.
The core class for Sperowider, this class is configured by a SperowiderRunner and then run.
Sperowider(SperowiderConfiguration) - Constructor for class org.erowid.sperowider.Sperowider
Constructs a new Sperowider on the basis of an SperowiderConfiguration.
SperowiderCommandInterpreter - class org.erowid.sperowider.SperowiderCommandInterpreter.
This class is used to perform certain transforms to comments in HTML, if they match the Sperowider command syntax.
SperowiderCommandInterpreter() - Constructor for class org.erowid.sperowider.SperowiderCommandInterpreter
 
SperowiderConfiguration - class org.erowid.sperowider.configuration.SperowiderConfiguration.
Holds configuration information for constructing a Sperowider.
SperowiderConfiguration(String, ISperowiderFilter, ISperowiderModel, boolean, boolean, boolean, String, long, int, String, String, String, String, String, int, boolean) - Constructor for class org.erowid.sperowider.configuration.SperowiderConfiguration
Brutal configuration
SperowiderConfiguration() - Constructor for class org.erowid.sperowider.configuration.SperowiderConfiguration
Default constructor.
SperowiderConfigurator - class org.erowid.sperowider.configuration.SperowiderConfigurator.
Given a JDOM Document, this class will instantiate, configure, and return a Sperowider.
SperowiderConfigurator() - Constructor for class org.erowid.sperowider.configuration.SperowiderConfigurator
 
SperowiderContext - class org.erowid.sperowider.SperowiderContext.
This class holds references to all of the high level "global" objects used in Sperowider.
SperowiderContext() - Constructor for class org.erowid.sperowider.SperowiderContext
Creates a new SperowiderContext.
SperowiderInstantiationException - exception org.erowid.sperowider.configuration.SperowiderInstantiationException.
An exception in instantiating and configuring Sperowider stuff.
SperowiderInstantiationException() - Constructor for class org.erowid.sperowider.configuration.SperowiderInstantiationException
Standard constructor.
SperowiderInstantiationException(String) - Constructor for class org.erowid.sperowider.configuration.SperowiderInstantiationException
Standard constructor.
SperowiderInstantiationException(Throwable) - Constructor for class org.erowid.sperowider.configuration.SperowiderInstantiationException
Standard constructor.
SperowiderInstantiationException(String, Throwable) - Constructor for class org.erowid.sperowider.configuration.SperowiderInstantiationException
Standard constructor.
SperowiderModel - class org.erowid.sperowider.hsqldb.SperowiderModel.
An ISperowiderModel backed by an HSQLDB database instance
SperowiderModel() - Constructor for class org.erowid.sperowider.hsqldb.SperowiderModel
Default constructor for model.
SperowiderModel(String, boolean, boolean, String) - Constructor for class org.erowid.sperowider.hsqldb.SperowiderModel
A constructor, really for test purposes only.
SperowiderModelReporterHelper - class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper.
A reporting helper for ISperowiderModel objects.
SperowiderModelReporterHelper() - Constructor for class org.erowid.sperowider.modelreporting.SperowiderModelReporterHelper
 
SperowiderRunner - class org.erowid.sperowider.SperowiderRunner.
The main class for the Sperowider, this class handles reading and using the configuration file to configure the Sperowider class, and then delegating to that class.
SperowiderRunner() - Constructor for class org.erowid.sperowider.SperowiderRunner
 
SplitIndexDirectory - class org.erowid.sperosearch.splitindex.SplitIndexDirectory.
A read-only Directory for use with Lucene.
SplitIndexDirectoryDescriptor - class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor.
Information about a directory with a split index.
SplitIndexDirectoryDescriptor(URL) - Constructor for class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Creates a read-only descriptor.
SplitIndexFileDescriptor - class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor.
A descriptor of a logical file in a split index.
SplitIndexFileDescriptor(SplitIndexDirectoryDescriptor, String) - Constructor for class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor
Creates a(n) SperowiderSplitIndexFileDescriptor object in writeable mode.
SplitIndexFileInputStream - class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream.
Random access file over a set of compressed segment files.
SplitIndexFileInputStream(SplitIndexFileDescriptor, SplitIndexSegmentFactory) - Constructor for class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
Creates a(n) SplitFileInputStream object.
SplitIndexLuceneInputStream - class org.erowid.sperosearch.splitindex.SplitIndexLuceneInputStream.
An input stream, based on SplitIndexFileInputStream for Lucene.
SplitIndexLuceneInputStream(SplitIndexFileInputStream) - Constructor for class org.erowid.sperosearch.splitindex.SplitIndexLuceneInputStream
Creates a(n) SplitIndexLuceneInputStream object.
SplitIndexSegment - class org.erowid.sperosearch.splitindex.SplitIndexSegment.
A segment of a SplitIndexFileInputStream in a SplitIndexDirectory.
SplitIndexSegment(SplitIndexFileDescriptor, int) - Constructor for class org.erowid.sperosearch.splitindex.SplitIndexSegment
Creates a(n) SplitIndexSegment object.
SplitIndexSegmentFactory - class org.erowid.sperosearch.splitindex.SplitIndexSegmentFactory.
A factory and cache of SplitIndexSegment objects.
SplitIndexSegmentFactory(int) - Constructor for class org.erowid.sperosearch.splitindex.SplitIndexSegmentFactory
Creates a(n) SplitIndexSegmentFactory object.
SummaryReportGenerator - class org.erowid.sperowider.SummaryReportGenerator.
Generates a report to an html doc after a download run.
SummaryReportGenerator(String) - Constructor for class org.erowid.sperowider.SummaryReportGenerator
Default constructor
saveDescriptor() - Method in class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor
Saves this directory descriptor.
scrollReaderToPattern(BufferedReader, Writer, String) - Static method in class org.erowid.sperowider.htmlshredding.Tools
Scrolls through the reader, writing to the writer, until it finds the pattern, then it returns true.
search(String) - Method in class org.erowid.sperosearch.SearchIndexReader
Executes a search on the Lucene search base, and returns a set of SearchResults for that term.
search(String) - Method in class org.erowid.sperosearch.SearcherApplet
Delegates to search(term, true).
search(String, boolean) - Method in class org.erowid.sperosearch.SearcherApplet
Searches for URLs that matches the current set of search criteria, and returns the number of matching URLs found.
seek(long) - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
Skips to the position.
seekInternal(long) - Method in class org.erowid.sperosearch.splitindex.SplitIndexLuceneInputStream
 
set(String, Object) - Method in class org.erowid.sperowider.configuration.Configuration
Sets the value of the setting.
setApiUrl(String) - Method in class org.erowid.masterdoc.ExternalRepository
 
setCommentText(String) - Method in class org.erowid.sperowider.SperowiderCommandInterpreter
Sets the comment text, to prepare for parsing.
setCompressIndex(boolean) - Method in class org.erowid.sperowider.SperowiderContext
Sets the compressIndex.
setConfigurationSource(String) - Method in class org.erowid.sperowider.Sperowider
Sets an arbitrary string that is the source of the configuration
setContent(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLKeywordTag
Sets the content attribute, which is a list of keywords in this case.
setContent(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLMetaTag
Sets the content attribute
setData(String[], long) - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileDescriptor
Sets the array of the segment file names, in order.
setDefault(String, Object) - Method in class org.erowid.sperowider.configuration.Configuration
Sets the default value of the setting.
setDescription(String) - Method in class org.erowid.masterdoc.ExternalLink
Sets the description.
setDownloadRoot(String) - Method in class org.erowid.sperowider.SperowiderContext
 
setExternalApiRoot(String) - Method in class org.erowid.masterdoc.MasterRepository
Sets the external API root
setExternalDocRoot(String) - Method in class org.erowid.masterdoc.MasterRepository
Sets the external doc root
setExternalSearchRoot(String) - Method in class org.erowid.masterdoc.MasterRepository
Sets the external search root
setFileNameManager(FileNameManager) - Method in class org.erowid.sperowider.SperowiderContext
 
setFollowChar(char) - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Sets the follow character for this tag.
setFollowChar(char) - Method in class org.erowid.sperowider.htmlshredding.ScriptTag
The script tag has both a starting and ending tag, so this is ignored
setGeneralUrl(String) - Method in class org.erowid.masterdoc.Repository
 
setGenerateApi(boolean) - Method in class org.erowid.masterdoc.MasterRepository
Sets the generateAPI flag.
setGenerateDocs(boolean) - Method in class org.erowid.masterdoc.MasterRepository
Sets if the docbase should be generated
setGenerateSearch(boolean) - Method in class org.erowid.masterdoc.MasterRepository
Set true to generate the searchbase
setHandlerPool(HandlerPool) - Method in class org.erowid.sperowider.SperowiderContext
 
setIgnoreNull(String, Object) - Method in class org.erowid.sperowider.configuration.Configuration
Sets the value of the setting, unless value is null.
setImage(String) - Method in class org.erowid.sperosearch.SearcherApplet
Sets the image to display in this applet.
setIncludeApiInSearch(boolean) - Method in class org.erowid.masterdoc.MasterRepository
 
setIncludeDocsInSearch(boolean) - Method in class org.erowid.masterdoc.MasterRepository
 
setIndexLimit(int) - Method in class org.erowid.sperowider.SperowiderContext
Sets the number of characters to be indexed.
setInternalApiRoot(File) - Method in class org.erowid.masterdoc.MasterRepository
Sets the internal API root
setInternalDocRoot(File) - Method in class org.erowid.masterdoc.MasterRepository
Sets the internal doc root
setInternalMainRoot(File) - Method in class org.erowid.masterdoc.MasterRepository
 
setInternalSearchRoot(File) - Method in class org.erowid.masterdoc.MasterRepository
Sets the internal search root
setLeadChar(char) - Method in class org.erowid.sperowider.htmlshredding.HTMLMetaTag
Meta tags are self terminating, so this does nothing.
setLeadChar(char) - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Sets the lead character for this tag.
setLeadChar(char) - Method in class org.erowid.sperowider.htmlshredding.ScriptTag
The script tag has both a starting and ending tag, so this is ignored.
setLimit(int) - Method in class org.erowid.sperowider.DownloadRunner
Sets the total number of files to download.
setLimit(int) - Method in class org.erowid.sperowider.Sperowider
 
setLongDescription(String) - Method in class org.erowid.masterdoc.Repository
 
setMessage(String, String) - Method in class org.erowid.sperowider.configuration.Configuration
Sets the required/default message for a setting.
setName(String) - Method in class org.erowid.masterdoc.ExternalLink
Sets the name.
setName(String) - Method in class org.erowid.masterdoc.Repository
 
setName(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLKeywordTag
Does nothing; the name is "keywords"
setName(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLMetaTag
Sets the name attribute
setName(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLTagAttribute
Sets the attribute name.
setPattern(String) - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
Sets the pattern used to find URLs.
setReplacementRegex(String) - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
Sets the replacement pattern to replace found URLs with.
setSearchEngineType(String) - Method in class org.erowid.masterdoc.MasterRepository
 
setSegmentSize(int) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectoryDescriptor
Sets the segment size, preperator to saving.
setSegmentSize(int) - Method in class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor
 
setShortDescription(String) - Method in class org.erowid.masterdoc.Repository
 
setShouldDownload(boolean) - Method in class org.erowid.sperowider.Sperowider
Set this to true if you want downloading to happen when Sperowider.run() is called.
setShouldIndex(boolean) - Method in class org.erowid.sperowider.Sperowider
Set this to true if you want indexing to happen when Sperowider.run() is called.
setShouldRectify(boolean) - Method in class org.erowid.sperowider.Sperowider
Set this to true if you want rectifying to happen when Sperowider.run() is called.
setSperowiderContext(SperowiderContext) - Method in class org.erowid.sperowider.AHandler
 
setSperowiderModel(ISperowiderModel) - Method in class org.erowid.sperowider.SperowiderContext
 
setSummaryFileName(String) - Method in class org.erowid.sperowider.Sperowider
 
setSummaryFooterFileName(String) - Method in class org.erowid.sperowider.Sperowider
 
setSummaryHeaderFileName(String) - Method in class org.erowid.sperowider.Sperowider
 
setTagName(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Sets the tag name, the thing that starts a tag off (the "a" in "", etc.)
setText(String) - Method in class org.erowid.sperosearch.SearcherApplet
Sets the text displayed in this applet.
setThrottle(long) - Method in class org.erowid.sperowider.Sperowider
Sets the throttle length, in milliseconds.
setThrottle(IThrottle) - Method in class org.erowid.sperowider.SperowiderContext
 
setURLFilter(ISperowiderFilter) - Method in class org.erowid.sperowider.SperowiderContext
 
setURLGroup(int) - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
Sets the number of the pattern group in the pattern set by PatternMatchingMongler.setPattern(String) that has the actual URL in it.
setUnlessSet(String, Object) - Method in class org.erowid.sperowider.configuration.Configuration
If the setting has not already been set, this will set it.
setUnlessSetIgnoreNull(String, Object) - Method in class org.erowid.sperowider.configuration.Configuration
Executes Configuration.setUnlessSet(String, Object), unless the value is null.
setUrl(String) - Method in class org.erowid.masterdoc.ExternalLink
Sets the url.
setUseDefaultDependencies(boolean) - Method in class org.erowid.masterdoc.InternalRepository
Will have this repository use the default internal dependency list.
setUseReplacementPattern(boolean) - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
Set this to true if the replacement pattern should be used to replace found URLs.
setValue(String) - Method in class org.erowid.sperowider.htmlshredding.HTMLTagAttribute
Sets the attribute value.
shmongle(BufferedReader) - Method in class org.erowid.sperowider.htmlshredding.HTMLShmongler
Takes an BufferedReader and cracks that into the contained collection of HTML elements.
shred(BufferedReader) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
Takes an InputStreamReader and cracks that into the contained collection of HTML elements.
skip(long) - Method in class org.erowid.sperosearch.splitindex.SplitIndexFileInputStream
 
skip(int) - Method in class org.erowid.sperowider.htmlshredding.RawHtmlData
Skips forward or back a number of spaces, and returns the position it's at.
spider(String) - Method in class org.erowid.sperowider.ASpiderBase
Downloads and spiders the passed in URL.
spider() - Method in class org.erowid.sperowider.simple.SimpleSpider
Starts the spidering.
spiderMatch(String, String) - Method in class org.erowid.masterdoc.MasterDocFilter
Must match on includes, not on exclude.
spiderMatch(String, String) - Method in class org.erowid.sperowider.urlfilter.BlocksAllFilter
Returns false
spiderMatch(String, String) - Method in interface org.erowid.sperowider.urlfilter.ISpiderFilter
Given a source URL and a URL found on the page at that URL, returns true if the URL found URL should be added to the list of URLs to download and spider.
spiderMatch(String, String) - Method in class org.erowid.sperowider.urlfilter.NoHopRegexSperowiderFilter
Returns true if the found URL matches at least one of the include patterns, and matches none of the exclude patterns.
spiderMatch(String, String) - Method in class org.erowid.sperowider.urlfilter.NoHopSimpleSperowiderFilter
Returns true if the found URL matches at least one of the include patterns, and matches none of the exclude patterns.
spiderMatch(String, String) - Method in class org.erowid.sperowider.urlfilter.OneHopRegexSperowiderFilter
Returns true if the found or source Urls is in the include list, and the found URL is not in the excludes list.
spiderMatch(String, String) - Method in class org.erowid.sperowider.urlfilter.OneHopSimpleSperowiderFilter
Returns true if the found or source Urls is in the include list, and the found URL is not in the excludes list.
split(String, int) - Static method in class org.erowid.sperowider.FileUtils
Splits a file into multiple files, each equal to the passed in length, except for the last file, which will probably be smaller as it's what is left.
split(File, int) - Static method in class org.erowid.sperowider.FileUtils
Splits a file into multiple files, each equal to the passed in length, except for the last file, which will probably be smaller as it's what is left.
split(InputStream, File, int) - Static method in class org.erowid.sperowider.FileUtils
Copes length bytes from the InputStream to a file.
splitAndCompress(String, int) - Static method in class org.erowid.sperowider.FileUtils
Splits a file into pieces, and then gzips each piece.
splitAndCompress(File, int) - Static method in class org.erowid.sperowider.FileUtils
Splits a file into pieces, and then gzips each piece.
stampFile(Writer, URL) - Method in class org.erowid.sperowider.AHandler
Writes an "originally found at" stamp into the passed in writer, which typically points to the downloaded file.
stampFile(Writer, URL) - Method in class org.erowid.sperowider.TextCssHandler
CSS specific file stamper.
start() - Method in class org.erowid.sperosearch.SearcherApplet
Automatically called by the Java Plugin.
start() - Method in class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
Opens files, adds headers.
start() - Method in interface org.erowid.sperowider.modelreporting.ISperowiderModelReporter
Called to start the reporter.
start() - Method in class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
Does nothing.
stop() - Method in class org.erowid.sperosearch.SearcherApplet
Automatically called by the Java Plugin.
stop() - Method in class org.erowid.sperowider.modelreporting.HtmlGeneratingSperowiderModelReporter
Adds footers, closes files.
stop() - Method in interface org.erowid.sperowider.modelreporting.ISperowiderModelReporter
Called to stop the reporter.
stop() - Method in class org.erowid.sperowider.modelreporting.LoggingSperowiderModelReporter
Does nothing.

T

THROTTLE - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
Throttle setting name.
TextCssHandler - class org.erowid.sperowider.TextCssHandler.
A Handler for dealing with CSS files, it replaces URLs inside url().
TextCssHandler() - Constructor for class org.erowid.sperowider.TextCssHandler
 
TextHtmlHandler - class org.erowid.sperowider.TextHtmlHandler.
This class does the downloading and spidering of HTML files.
TextHtmlHandler() - Constructor for class org.erowid.sperowider.TextHtmlHandler
 
Throttle - class org.erowid.sperowider.Throttle.
A concrete implementation of IThrottle, this class is constructed with the minimum number of milliseconds that must pass between consecutive times that Throttle.throttle() will unblock.
Throttle(long) - Constructor for class org.erowid.sperowider.Throttle
Creates a new Throttle with a delay in milliseconds.
Tools - class org.erowid.sperowider.htmlshredding.Tools.
Utilties for Shredding
Tools() - Constructor for class org.erowid.sperowider.htmlshredding.Tools
 
TwoWayMapTable - class org.erowid.sperowider.hsqldb.TwoWayMapTable.
This is a wrapper around a many-to-many table.
TwoWayMapTable(String, Connection, int) - Constructor for class org.erowid.sperowider.hsqldb.TwoWayMapTable
Constructor, gets everything ready for usage.
tableExists() - Method in class org.erowid.sperowider.hsqldb.BasicTable
Returns true if the backing table actually exists.
throttle() - Method in interface org.erowid.sperowider.IThrottle
Implementations of this class should pause appropriately when this method is called to delay downloading files.
throttle() - Method in class org.erowid.sperowider.NonThrottle
Returns instantly, for (effectively) no throttling at all.
throttle() - Method in class org.erowid.sperowider.Throttle
This method blocks until the set number of milliseconds has passed since the last time this method returned.
toString() - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Returns the text of this tag
toString() - Method in class org.erowid.sperowider.htmlshredding.MongledURLType
Returns a string representation of this URLType
toString() - Method in class org.erowid.sperowider.urlfilter.AIncludeExcludeFilter
Returns a meaningful string representation of this filter.
touchFile(String) - Method in class org.erowid.sperosearch.splitindex.SplitIndexDirectory
Does nothing, because this is a read only directory.

U

URLFilter - class org.erowid.sperowider.urlfilter.URLFilter.
Deprecated. Use NoHopSimpleSperowiderFilter instead.
URLFilter() - Constructor for class org.erowid.sperowider.urlfilter.URLFilter
Deprecated.  
URLMongler - class org.erowid.sperowider.htmlshredding.URLMongler.
This abstract class provides "URL Mongling" functionality for any of several kind of data sources, including URLs, files, input streams, among others.
URLMongler() - Constructor for class org.erowid.sperowider.htmlshredding.URLMongler
 
URL_FILTER - Static variable in class org.erowid.sperowider.configuration.SperowiderConfiguration
URL filter setting name.
unprocess(File) - Method in class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor
Mostly for testing purposes, this will take a processed directory of files and its descriptor, and generate the original data from it.
urlFound(String) - Method in class org.erowid.sperowider.htmlshredding.AMongler
Extending classes should return the URL to replace the passed in URL, or null to indicate that it should be kept.
urlFound(String) - Method in class org.erowid.sperowider.htmlshredding.CSSURLMongler
 
urlFound(String) - Method in class org.erowid.sperowider.htmlshredding.PatternMatchingMongler
 
urlFound(String, MongledURLType) - Method in class org.erowid.sperowider.htmlshredding.URLMongler
This method is called when a URL is found in the shredded HTML.
urlFoundInRectify(String, String) - Method in class org.erowid.sperowider.AHandler
Called by descendant classes when they find a URL during rectifying.
urlFoundInSpider(URL, String) - Method in class org.erowid.sperowider.AHandler
Called by descendant classes when they find a URL during spidering.

W

WHEN_LIMIT_IS_REACHED - Static variable in class org.erowid.sperowider.DownloadRunner
The termination type indicating that files should be downloaded and spidered until the limit (as set via DownloadRunner.setLimit(int)) is reached, or until no more URLs are found.
WHEN_NO_MORE_URLS - Static variable in class org.erowid.sperowider.DownloadRunner
The termination type indicating that files should be downloaded and spidered until no more valid files are found.
WriteableSplitIndexDirectoryDescriptor - class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor.
A writeable form of SplitIndexDirectoryDescriptor.
WriteableSplitIndexDirectoryDescriptor(File) - Constructor for class org.erowid.sperosearch.splitindex.WriteableSplitIndexDirectoryDescriptor
Creates a(n) WriteableSplitIndexDirectoryDescriptor object.
WriteableSplitIndexFileDescriptor - class org.erowid.sperosearch.splitindex.WriteableSplitIndexFileDescriptor.
A writeable form of WriteableSplitIndexFileDescriptor.
WriteableSplitIndexFileDescriptor(WriteableSplitIndexDirectoryDescriptor, File) - Constructor for class org.erowid.sperosearch.splitindex.WriteableSplitIndexFileDescriptor
Creates a(n) WriteableSplitIndexFileDescriptor object.
write(Writer) - Method in class org.erowid.sperowider.htmlshredding.HTMLComment
 
write(Writer) - Method in class org.erowid.sperowider.htmlshredding.HTMLDocType
 
write(Writer) - Method in interface org.erowid.sperowider.htmlshredding.HTMLElement
Writes the HTMLElement as HTML to the passed in Writer.
write(Writer) - Method in class org.erowid.sperowider.htmlshredding.HTMLShredder
 
write(Writer) - Method in class org.erowid.sperowider.htmlshredding.HTMLTag
Writes the text version of this tag to the passed in Writer
write(Writer, boolean) - Method in class org.erowid.sperowider.htmlshredding.HTMLTagAttribute
 
write(Writer) - Method in class org.erowid.sperowider.htmlshredding.HTMLText
Returns the text that represents this chunk of text.
write(Writer) - Method in class org.erowid.sperowider.htmlshredding.ScriptTag
Writes script element to writer

A B C D E F G H I J L M N O P R S T U W
spero logo small Sperowider is
© 2005 Erowid.org