Uses of Package
com.sun.labs.minion

Packages that use com.sun.labs.minion
com.sun.labs.minion Provides the API for interacting with the Minion Search Engine. 
com.sun.labs.minion.classification Provides the automatic document classification functionality in Minion. 
com.sun.labs.minion.clustering Provides document clustering functionality. 
com.sun.labs.minion.document Provides some basic document analysis for different types of text documents. 
com.sun.labs.minion.document.tokenizer Provides two implementations of tokenization for character streams. 
com.sun.labs.minion.engine Provides implementations for some of the end-user interfaces. 
com.sun.labs.minion.indexer Provides classes that do the main work of indexing: building the term and document dictionaries and the postings file. 
com.sun.labs.minion.indexer.dictionary Provides the classes that implement the dictionaries used by the indexer and the retrieval engine. 
com.sun.labs.minion.indexer.partition Provides the classes that implement the partitions of the indexer. 
com.sun.labs.minion.indexer.postings Provides the classes that implement the different types of postings used by the search engine. 
com.sun.labs.minion.lexmorph.disambiguation   
com.sun.labs.minion.pipeline Provides the classes for building a pipeline. 
com.sun.labs.minion.retrieval Provides the query evaluation capabilities for Minion. 
com.sun.labs.minion.retrieval.cache   
com.sun.labs.minion.samples Provides sample code for using Minion. 
com.sun.labs.minion.test Provides test classes and utilities for indexing and querying. 
com.sun.labs.minion.test.regression Provides the classes that generates the entries and queries for the regression test. 
com.sun.labs.minion.test.regression.deletion   
com.sun.labs.minion.test.regression.merge   
com.sun.labs.minion.test.regression.query Contains classes that provide query regression tests. 
 

Classes in com.sun.labs.minion used by com.sun.labs.minion
Classifier
          This interface represents the classification features of the search engine.
ClusterStatistics
          An interface for getting a number of statistics relating to a cluster of documents.
CustomAnalyzer
          The interface used to provide a custom analzyer for text that will be indexed.
Document
          A document abstraction for the search engine.
DocumentVector
          An interface defining the behavior of document vectors.
FieldFrequency
          A class that encapsulates a field value and a frequency for that value.
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
FieldInfo.Attribute
          The various attributes that a field can have.
FieldInfo.Type
          The types that a saved field can have.
FieldValue
          A class containing a single field value and an associated score.
HLPipeline
          A pipeline that can be used for highlighting documents.
Indexable
          An interface that should be implemented by things that are indexable.
IndexableFile
          An extension of File that stores the encoding used for the file.
IndexableFile.Type
           
IndexableString
          A class that holds a string along with some information about any markup used in the string.
IndexableString.Type
           
IndexConfig
          A class that holds configuration data for indexing documents.
IndexListener
          An interface that clients can implement to be notified when things happen in an index.
Log
          Deprecated. 
MetaDataStore
          The MetaDataStore provides a mechanism to store name/value pairs in associate with an index.
Passage
          An interface for a class that holds the information for a passage generated from a search.
Passage.Type
          The types of passage that we will return.
PassageBuilder
          An interface that will allow applications to build a set of passages to display from a search result.
PassageHighlighter
          An interface for providing call back functions when doing passage highlighting.
Pipeline
          A class that encapsulates the machinery of a single indexing pipeline.
PipelineStage
          The interface to a stage in the indexing pipeline.
Posting
          A single posting from a document, composed of a term and the frequency of that term in the document.
Progress
          An interface for tracking progress
QueryConfig
          A class that holds configuration data for querying.
QueryStats
          A class to hold statistics generated during a single or many queries.
Result
          A class that holds a single search result.
ResultAccessor
          An interface for accessing the values associated with a search result that is being considered for inclusion in a list of results returned to a user.
ResultsCluster
          A cluster of results from a search engine.
ResultSet
          A class that holds the results of a search.
ResultsFilter
          A filter for results that can be applied against a result set when retrieving results for display.
ScoreModifier
          An interface for clases that would like the opportunity to modify document scores at the time that they are being considered for inclusion into a set of results returned from the search engine.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
Searcher
          An interface for things that know how to run a search.
SimpleIndexer
          An interface that allows one fairly straightforward access to the indexing API.
TermStats
          An interface to some standard term statistics.
WeightedField
          A class that contains the name of a field and a weight that should be applied to the similarity values for that field when finding documents similar to a given document.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.classification
DocumentVector
          An interface defining the behavior of document vectors.
FieldValue
          A class containing a single field value and an associated score.
IndexConfig
          A class that holds configuration data for indexing documents.
Progress
          An interface for tracking progress
ResultSet
          A class that holds the results of a search.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.clustering
ClusterStatistics
          An interface for getting a number of statistics relating to a cluster of documents.
Result
          A class that holds a single search result.
ResultsCluster
          A cluster of results from a search engine.
ResultSet
          A class that holds the results of a search.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.document
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.document.tokenizer
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
IndexConfig
          A class that holds configuration data for indexing documents.
PipelineStage
          The interface to a stage in the indexing pipeline.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.engine
Classifier
          This interface represents the classification features of the search engine.
Document
          A document abstraction for the search engine.
DocumentVector
          An interface defining the behavior of document vectors.
FieldFrequency
          A class that encapsulates a field value and a frequency for that value.
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
FieldValue
          A class containing a single field value and an associated score.
HLPipeline
          A pipeline that can be used for highlighting documents.
Indexable
          An interface that should be implemented by things that are indexable.
IndexConfig
          A class that holds configuration data for indexing documents.
IndexListener
          An interface that clients can implement to be notified when things happen in an index.
MetaDataStore
          The MetaDataStore provides a mechanism to store name/value pairs in associate with an index.
Pipeline
          A class that encapsulates the machinery of a single indexing pipeline.
Posting
          A single posting from a document, composed of a term and the frequency of that term in the document.
Progress
          An interface for tracking progress
QueryConfig
          A class that holds configuration data for querying.
QueryStats
          A class to hold statistics generated during a single or many queries.
ResultSet
          A class that holds the results of a search.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
Searcher
          An interface for things that know how to run a search.
SimpleIndexer
          An interface that allows one fairly straightforward access to the indexing API.
TermStats
          An interface to some standard term statistics.
WeightedField
          A class that contains the name of a field and a weight that should be applied to the similarity values for that field when finding documents similar to a given document.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.indexer
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
FieldInfo.Attribute
          The various attributes that a field can have.
FieldInfo.Type
          The types that a saved field can have.
SearchEngineException
           
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.indexer.dictionary
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
FieldInfo.Attribute
          The various attributes that a field can have.
FieldInfo.Type
          The types that a saved field can have.
FieldValue
          A class containing a single field value and an associated score.
QueryStats
          A class to hold statistics generated during a single or many queries.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.indexer.partition
Document
          A document abstraction for the search engine.
DocumentVector
          An interface defining the behavior of document vectors.
FieldFrequency
          A class that encapsulates a field value and a frequency for that value.
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
FieldValue
          A class containing a single field value and an associated score.
IndexConfig
          A class that holds configuration data for indexing documents.
IndexListener
          An interface that clients can implement to be notified when things happen in an index.
PipelineStage
          The interface to a stage in the indexing pipeline.
QueryConfig
          A class that holds configuration data for querying.
ResultSet
          A class that holds the results of a search.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
WeightedField
          A class that contains the name of a field and a weight that should be applied to the similarity values for that field when finding documents similar to a given document.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.indexer.postings
QueryStats
          A class to hold statistics generated during a single or many queries.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.lexmorph.disambiguation
Result
          A class that holds a single search result.
ResultsCluster
          A cluster of results from a search engine.
ResultSet
          A class that holds the results of a search.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.pipeline
Document
          A document abstraction for the search engine.
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
HLPipeline
          A pipeline that can be used for highlighting documents.
Indexable
          An interface that should be implemented by things that are indexable.
IndexableString
          A class that holds a string along with some information about any markup used in the string.
IndexableString.Type
           
IndexConfig
          A class that holds configuration data for indexing documents.
Passage.Type
          The types of passage that we will return.
PassageBuilder
          An interface that will allow applications to build a set of passages to display from a search result.
Pipeline
          A class that encapsulates the machinery of a single indexing pipeline.
PipelineStage
          The interface to a stage in the indexing pipeline.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
SimpleIndexer
          An interface that allows one fairly straightforward access to the indexing API.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.retrieval
Document
          A document abstraction for the search engine.
DocumentVector
          An interface defining the behavior of document vectors.
FieldInfo
          A class that can be used to tell the indexer what to do with the data contained in a field.
HLPipeline
          A pipeline that can be used for highlighting documents.
Passage
          An interface for a class that holds the information for a passage generated from a search.
Passage.Type
          The types of passage that we will return.
PassageBuilder
          An interface that will allow applications to build a set of passages to display from a search result.
PassageHighlighter
          An interface for providing call back functions when doing passage highlighting.
PipelineStage
          The interface to a stage in the indexing pipeline.
QueryConfig
          A class that holds configuration data for querying.
QueryStats
          A class to hold statistics generated during a single or many queries.
Result
          A class that holds a single search result.
ResultAccessor
          An interface for accessing the values associated with a search result that is being considered for inclusion in a list of results returned to a user.
ResultsCluster
          A cluster of results from a search engine.
ResultSet
          A class that holds the results of a search.
ResultsFilter
          A filter for results that can be applied against a result set when retrieving results for display.
ScoreModifier
          An interface for clases that would like the opportunity to modify document scores at the time that they are being considered for inclusion into a set of results returned from the search engine.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
TermStats
          An interface to some standard term statistics.
WeightedField
          A class that contains the name of a field and a weight that should be applied to the similarity values for that field when finding documents similar to a given document.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.retrieval.cache
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.samples
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.test
DocumentVector
          An interface defining the behavior of document vectors.
Indexable
          An interface that should be implemented by things that are indexable.
IndexableFile
          An extension of File that stores the encoding used for the file.
Result
          A class that holds a single search result.
ResultAccessor
          An interface for accessing the values associated with a search result that is being considered for inclusion in a list of results returned to a user.
ResultSet
          A class that holds the results of a search.
ResultsFilter
          A filter for results that can be applied against a result set when retrieving results for display.
SearchEngine
          This is the main interface for the search engine, which handles both indexing and retrieval operations.
SearchEngineException
           
Searcher
          An interface for things that know how to run a search.
TextHighlighter
          A simple class for doing textual highlighting of a passage.
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.test.regression
IndexConfig
          A class that holds configuration data for indexing documents.
SearchEngineException
           
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.test.regression.deletion
SearchEngineException
           
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.test.regression.merge
SearchEngineException
           
 

Classes in com.sun.labs.minion used by com.sun.labs.minion.test.regression.query
SearchEngineException