Cheshire3
Installation
Requirements / Dependencies
Installation
Tutorials
Command-line UI
Python API
Configuring Databases
Configuring Indexes
Configuring Stores
Configuring Workflows
Commands
Introduction
cheshire3
cheshire3-init
cheshire3-register
cheshire3-load
cheshire3-search
cheshire3-serve
Configuration
Common Configurations
Index Configuration
ProtocolMap Configuration
Workflow Configuration
Introduction
Configuration Elements
Example
Objects
Cheshire3 Object Model - Abstract Base Class
Cheshire3 Object Model - Database
Cheshire3 Object Model - Document
Cheshire3 Object Model - DocumentFactory
Cheshire3 Object Model - DocumentStore
Cheshire3 Object Model - Extractor
Cheshire3 Object Model - Index
Cheshire3 Object Model - IndexStore
Cheshire3 Object Model - ObjectStore
Cheshire3 Object Model - Parser
Cheshire3 Object Model - PreParser
Cheshire3 Object Model - Record
Cheshire3 Object Model - RecordStore
Cheshire3 Object Model - ResultSet
Cheshire3 Object Model - ResultSetStore
Cheshire3 Object Model - Selector
Cheshire3 Object Model - Server
Cheshire3 Object Model - TokenMerger
Cheshire3 Object Model - Tokenizer
Cheshire3 Object Model - Transformer
Cheshire3 Object Model - User
Cheshire3 Object Model - Workflow
Overview
Miscellaneous
Summary Objects
ResultSetStore
Data Objects
Processing Objects
Other Notable Modules
Troubleshooting
Introduction
Common Run-time Errors
Apache Errors
Cheshire3
Docs
»
Edit on GitHub
Index
Symbols
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
|
X
Symbols
--help
cheshire3-register command line option
--hostname <HOSTNAME>
cheshire3-serve command line option
--interactive
cheshire3 command line option
--server-config <PATH>
cheshire3-register command line option
cheshire3-search command line option
-c <CODEC>, --codec <CODEC>
cheshire3-load command line option
-c <DESCRIPTION>, --description <DESCRIPTION>
cheshire3-init command line option
-d <DATABASE>, --database <DATABASE>
cheshire3 command line option
cheshire3-init command line option
cheshire3-load command line option
cheshire3-search command line option
-f <FORMAT>, --format <FORMAT>
cheshire3-load command line option
cheshire3-search command line option
-h, --help
cheshire3 command line option
cheshire3-init command line option
cheshire3-load command line option
cheshire3-search command line option
cheshire3-serve command line option
-l <CACHE>, --cache-level <CACHE>
cheshire3-load command line option
-m <MAXIMUM>, --maximum-records <MAXIMUM>
cheshire3-search command line option
-p <PORT>, --port <PORT>
cheshire3-init command line option
cheshire3-serve command line option
-s <PATH>, --server-config <PATH>
cheshire3 command line option
cheshire3-init command line option
cheshire3-load command line option
cheshire3-serve command line option
-s <START>, --start-record <START>
cheshire3-search command line option
-t <TAGNAME>, --tagname <TAGNAME>
cheshire3-load command line option
-t <TITLE>, --title <TITLE>
cheshire3-init command line option
A
accumulate_metadata() (cheshire3.baseObjects.Database method)
add_auth() (cheshire3.baseObjects.C3Object method)
add_logging() (cheshire3.baseObjects.C3Object method)
add_record() (cheshire3.baseObjects.Database method)
AmpPreParser (class in cheshire3.preParser)
B
B64DecodePreParser (class in cheshire3.preParser)
B64EncodePreParser (class in cheshire3.preParser)
BdbDocumentStore (class in cheshire3.documentStore)
BdbIndexStore (class in cheshire3.indexStore)
BdbObjectStore (class in cheshire3.objectStore)
BdbRecordStore (class in cheshire3.recordStore)
BdbResultSetStore (class in cheshire3.resultSetStore)
begin_indexing() (cheshire3.baseObjects.Database method)
(cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
BitmapIndex (class in cheshire3.index)
Bzip2XmlTransformer (class in cheshire3.transformer)
C
C3Object (class in cheshire3.baseObjects)
CachingWorkflow (class in cheshire3.workflow)
CharacterEntityPreParser (class in cheshire3.preParser)
check_password() (cheshire3.user.SimpleUser method)
cheshire3 command line option
--interactive
-d <DATABASE>, --database <DATABASE>
-h, --help
-s <PATH>, --server-config <PATH>
script
cheshire3-init command line option
-c <DESCRIPTION>, --description <DESCRIPTION>
-d <DATABASE>, --database <DATABASE>
-h, --help
-p <PORT>, --port <PORT>
-s <PATH>, --server-config <PATH>
-t <TITLE>, --title <TITLE>
DIRECTORY
cheshire3-load command line option
-c <CODEC>, --codec <CODEC>
-d <DATABASE>, --database <DATABASE>
-f <FORMAT>, --format <FORMAT>
-h, --help
-l <CACHE>, --cache-level <CACHE>
-s <PATH>, --server-config <PATH>
-t <TAGNAME>, --tagname <TAGNAME>
data
cheshire3-register command line option
--help
--server-config <PATH>
CONFIGFILE
cheshire3-search command line option
--server-config <PATH>
-d <DATABASE>, --database <DATABASE>
-f <FORMAT>, --format <FORMAT>
-h, --help
-m <MAXIMUM>, --maximum-records <MAXIMUM>
-s <START>, --start-record <START>
query
cheshire3-serve command line option
--hostname <HOSTNAME>
-h, --help
-p <PORT>, --port <PORT>
-s <PATH>, --server-config <PATH>
cheshire3.bootstrap (module)
cheshire3.dynamic (module)
cheshire3.exceptions (module)
cheshire3.internal (module)
cheshire3.logger (module)
clean_index() (cheshire3.baseObjects.IndexStore method)
clear() (cheshire3.baseObjects.Index method)
ClusterExtractionDocumentFactory (class in cheshire3.documentFactory)
CmdLinePreParser (class in cheshire3.preParser)
combine() (cheshire3.baseObjects.ResultSet method)
commit_centralIndexing() (cheshire3.baseObjects.IndexStore method)
commit_indexing() (cheshire3.baseObjects.Database method)
(cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
commit_metadata() (cheshire3.baseObjects.Database method)
CONFIGFILE
cheshire3-register command line option
construct_resultSet() (cheshire3.baseObjects.Index method)
construct_resultSetItem() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
contains_index() (cheshire3.baseObjects.IndexStore method)
create_document() (cheshire3.baseObjects.DocumentStore method)
create_index() (cheshire3.baseObjects.IndexStore method)
create_object() (cheshire3.baseObjects.ObjectStore method)
create_record() (cheshire3.baseObjects.RecordStore method)
create_resultSet() (cheshire3.baseObjects.ResultSetStore method)
create_term() (cheshire3.baseObjects.IndexStore method)
D
data
cheshire3-load command line option
Database (class in cheshire3.baseObjects)
DateRangeTokenizer (class in cheshire3.tokenizer)
DateTokenizer (class in cheshire3.tokenizer)
delete_document() (cheshire3.baseObjects.DocumentStore method)
delete_index() (cheshire3.baseObjects.IndexStore method)
delete_object() (cheshire3.baseObjects.ObjectStore method)
delete_record() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.RecordStore method)
delete_resultSet() (cheshire3.baseObjects.ResultSetStore method)
delete_terms() (cheshire3.baseObjects.IndexStore method)
deserialize() (cheshire3.baseObjects.ResultSet method)
deserialize_term() (cheshire3.baseObjects.Index method)
DIRECTORY
cheshire3-init command line option
Document (class in cheshire3.baseObjects)
DocumentFactory (class in cheshire3.baseObjects)
DocumentStore (class in cheshire3.baseObjects)
E
extract_data() (cheshire3.baseObjects.Index method)
Extractor (class in cheshire3.baseObjects)
F
fetch_document() (cheshire3.baseObjects.DocumentStore method)
fetch_object() (cheshire3.baseObjects.ObjectStore method)
fetch_proxVector() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
fetch_record() (cheshire3.baseObjects.RecordStore method)
fetch_recordMetadata() (cheshire3.baseObjects.RecordStore method)
fetch_resultSet() (cheshire3.baseObjects.ResultSetStore method)
fetch_sortValue() (cheshire3.baseObjects.IndexStore method)
fetch_summary() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
fetch_term() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
fetch_termById() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
fetch_termFrequencies() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
fetch_termList() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
fetch_vector() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
(cheshire3.baseObjects.Record method)
FileSystemDocumentStore (class in cheshire3.documentStore)
FileUtilPreParser (class in cheshire3.preParser)
G
get_config() (cheshire3.baseObjects.C3Object method)
(cheshire3.baseObjects.Server method)
get_default() (cheshire3.baseObjects.C3Object method)
(cheshire3.baseObjects.Server method)
get_document() (cheshire3.baseObjects.DocumentFactory method)
get_dom() (cheshire3.baseObjects.Record method)
get_object() (cheshire3.baseObjects.C3Object method)
(cheshire3.baseObjects.Server method)
get_path() (cheshire3.baseObjects.C3Object method)
(cheshire3.baseObjects.Server method)
get_raw() (cheshire3.baseObjects.Document method)
get_sax() (cheshire3.baseObjects.Record method)
get_setting() (cheshire3.baseObjects.C3Object method)
(cheshire3.baseObjects.Server method)
get_xml() (cheshire3.baseObjects.Record method)
GraphRecord (class in cheshire3.graph.record)
GunzipPreParser (class in cheshire3.preParser)
GzipPreParser (class in cheshire3.preParser)
H
has_flag() (cheshire3.baseObjects.User method)
HtmlSmashPreParser (class in cheshire3.preParser)
HtmlTidyPreParser (class in cheshire3.preParser)
I
Index (class in cheshire3.baseObjects)
index_record() (cheshire3.baseObjects.Database method)
(cheshire3.baseObjects.Index method)
IndexStore (class in cheshire3.baseObjects)
L
LineTokenizer (class in cheshire3.tokenizer)
load() (cheshire3.baseObjects.DocumentFactory method)
LxmlHtmlParser (class in cheshire3.parser)
LxmlOffsetQueryTermHighlightingTransformer (class in cheshire3.transformer)
LxmlParser (class in cheshire3.parser)
LxmlRecord (class in cheshire3.record)
LxmlXsltTransformer (class in cheshire3.transformer)
M
MagicRedirectPreParser (class in cheshire3.preParser)
MarcParser (class in cheshire3.parser)
MarcRecord (class in cheshire3.record)
MarcToSgmlPreParser (class in cheshire3.preParser)
MarcToXmlPreParser (class in cheshire3.preParser)
MarcTransformer (class in cheshire3.transformer)
merge_term() (cheshire3.baseObjects.Index method)
MetadataSelector (class in cheshire3.selector)
MinidomParser (class in cheshire3.parser)
MinidomRecord (class in cheshire3.record)
MinMaxRangeTokenMerger (class in cheshire3.tokenMerger)
N
NGramTokenMerger (class in cheshire3.tokenMerger)
NormalizerPreParser (class in cheshire3.preParser)
O
ObjectStore (class in cheshire3.baseObjects)
OffsetProximityTokenMerger (class in cheshire3.tokenMerger)
OptimisingDatabase (class in cheshire3.database)
order() (cheshire3.baseObjects.ResultSet method)
OreGraphRecord (class in cheshire3.graph.record)
P
Parser (class in cheshire3.baseObjects)
PassThroughIndex (class in cheshire3.index)
PassThroughParser (class in cheshire3.parser)
PhraseTokenMerger (class in cheshire3.tokenMerger)
PicklePreParser (class in cheshire3.preParser)
PreParser (class in cheshire3.baseObjects)
PrintableOnlyPreParser (class in cheshire3.preParser)
process() (cheshire3.baseObjects.Workflow method)
process_document() (cheshire3.baseObjects.Parser method)
(cheshire3.baseObjects.PreParser method)
process_eventList() (cheshire3.baseObjects.Extractor method)
process_hash() (cheshire3.baseObjects.Tokenizer method)
(cheshire3.baseObjects.TokenMerger method)
process_node() (cheshire3.baseObjects.Extractor method)
process_record() (cheshire3.baseObjects.Selector method)
(cheshire3.baseObjects.Transformer method)
process_string() (cheshire3.baseObjects.Extractor method)
(cheshire3.baseObjects.TokenMerger method)
(cheshire3.baseObjects.Tokenizer method)
process_xpath() (cheshire3.baseObjects.Record method)
process_xpathResult() (cheshire3.baseObjects.Extractor method)
ProtocolMap (class in cheshire3.baseObjects)
ProximityIndex (class in cheshire3.index)
ProximityTokenMerger (class in cheshire3.tokenMerger)
PythonTokenizer (class in cheshire3.tokenizer)
Q
query
cheshire3-search command line option
R
RangeIndex (class in cheshire3.index)
RangeTokenMerger (class in cheshire3.tokenMerger)
ReconstructTokenMerger (class in cheshire3.tokenMerger)
Record (class in cheshire3.baseObjects)
RecordIdentifierIndex (class in cheshire3.index)
RecordStore (class in cheshire3.baseObjects)
RedirectRecordStore (class in cheshire3.recordStore)
RegexpFindOffsetTokenizer (class in cheshire3.tokenizer)
RegexpFindPunctuationOffsetTokenizer (class in cheshire3.tokenizer)
RegexpFindTokenizer (class in cheshire3.tokenizer)
RegexpSmashPreParser (class in cheshire3.preParser)
RegexpSplitTokenizer (class in cheshire3.tokenizer)
RegexpSubTokenizer (class in cheshire3.tokenizer)
register_stream() (cheshire3.baseObjects.DocumentFactory class method)
reindex() (cheshire3.baseObjects.Database method)
RemoteSlaveRecordStore (class in cheshire3.recordStore)
RemoteWriteRecordStore (class in cheshire3.recordStore)
remove_auth() (cheshire3.baseObjects.C3Object method)
remove_logging() (cheshire3.baseObjects.C3Object method)
remove_record() (cheshire3.baseObjects.Database method)
replace_record() (cheshire3.baseObjects.RecordStore method)
ResultSet (class in cheshire3.baseObjects)
ResultSetStore (class in cheshire3.baseObjects)
retrieve() (cheshire3.baseObjects.ResultSet method)
S
SaxParser (class in cheshire3.parser)
SaxRecord (class in cheshire3.record)
SaxTransformer (class in cheshire3.transformer)
scan() (cheshire3.baseObjects.Database method)
(cheshire3.baseObjects.Index method)
script
cheshire3 command line option
search() (cheshire3.baseObjects.Database method)
(cheshire3.baseObjects.Index method)
Selector (class in cheshire3.baseObjects)
SentenceTokenizer (class in cheshire3.tokenizer)
SequenceRangeTokenMerger (class in cheshire3.tokenMerger)
serialize() (cheshire3.baseObjects.ResultSet method)
serialize_term() (cheshire3.baseObjects.Index method)
Server (class in cheshire3.baseObjects)
Session (class in cheshire3.baseObjects)
SgmlPreParser (class in cheshire3.preParser)
SimpleDatabase (class in cheshire3.database)
SimpleDocumentFactory (class in cheshire3.documentFactory)
SimpleExtractor (class in cheshire3.extractor)
SimpleIndex (class in cheshire3.index)
SimpleResultSet (class in cheshire3.resultSet)
SimpleResultSetItem (class in cheshire3.resultSet)
SimpleServer (class in cheshire3.server)
SimpleTokenizer (class in cheshire3.tokenizer)
SimpleTokenMerger (class in cheshire3.tokenMerger)
SimpleUser (class in cheshire3.user)
SimpleWorkflow (class in cheshire3.workflow)
sort() (cheshire3.baseObjects.Database method)
(cheshire3.baseObjects.Index method)
SpanXPathExtractor (class in cheshire3.extractor)
SpanXPathSelector (class in cheshire3.selector)
store_document() (cheshire3.baseObjects.DocumentStore method)
store_object() (cheshire3.baseObjects.ObjectStore method)
store_record() (cheshire3.baseObjects.RecordStore method)
store_resultSet() (cheshire3.baseObjects.ResultSetStore method)
store_terms() (cheshire3.baseObjects.Index method)
(cheshire3.baseObjects.IndexStore method)
StoredSaxParser (class in cheshire3.parser)
StringDocument (class in cheshire3.document)
T
TeiExtractor (class in cheshire3.extractor)
TemplatedTransformer (class in cheshire3.transformer)
Tokenizer (class in cheshire3.baseObjects)
TokenMerger (class in cheshire3.baseObjects)
Transformer (class in cheshire3.baseObjects)
TransformerSelector (class in cheshire3.selector)
TxtToXmlPreParser (class in cheshire3.preParser)
U
UnicodeDecodePreParser (class in cheshire3.preParser)
unindex_record() (cheshire3.baseObjects.Database method)
UnpicklePreParser (class in cheshire3.preParser)
User (class in cheshire3.baseObjects)
W
Workflow (class in cheshire3.baseObjects)
WorkflowTransformer (class in cheshire3.transformer)
X
XmlIndex (class in cheshire3.index)
XmlProximityIndex (class in cheshire3.index)
XmlTransformer (class in cheshire3.transformer)
XPathSelector (class in cheshire3.selector)
Read the Docs
v: latest
Versions
release-1.1.0
latest
develop
1.0.16
Downloads
PDF
HTML
Epub
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.