|
Carrot2 v3.3.0
API Documentation |
||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||
true if the phrase located at phraseIndex
is to be accepted, false otherwise.
true if the phrase located at phraseIndex
is to be accepted, false otherwise.
true if the word located at wordIndex is to
be accepted, false otherwise.
true if the word located at wordIndex is to
be accepted, false otherwise.
IParameterizedPool.borrowObject(Class, Object).
AttributeValueSet to this collection.
AttributeValueSet to this collection replacing its label and
description.
IResourceLocators before existing defaults.
IResourceLocators after existing defaults.
IControllerContextListener to this context.
ISimpleXmlWrapper.
ISimpleXmlWrapper.
ControllerStatistics.algorithmTimeWindowSize.
ControllerStatistics.algorithmTimeWindowSize.
PreprocessingContext.documents.
PreprocessingContext.documents.
PreprocessingContext.documents.
PreprocessingContext.documents.
PreprocessingContext.documents.
PreprocessingContext.documents.
PreprocessingContext.documents.
PreprocessingContext.documents.
PreprocessingContext.documents.
PreprocessingContext.documents.
Analyzer used at indexing time.
ConstraintViolationException.offendingValue.
AttributeDescriptor.clusters.
clusters.
v1 and v2, weighting them
by w1 and w2, respectively.
DoubleMatrix2D into an NNI-backed matrix.
CharCharArrayAssert.
IntIntArrayAssert.
IntIntArrayAssert.
DoubleArrayAssert.
clusters (and their
sub-clusters).
documents.
AttributeBinder.Attribute annotation.Input attributes.Output attributes.String attribute values to the types required by the target
field by:
Leaving non-String typed values unchanged.
Looking for a static valueOf(String) in the target type and using
it for conversion.
If the method is not available, trying to load a class named as the value of
the attribute, so that this class can be further coerced to the class instance.
If the class cannot be loaded, leaving the the value unchanged.
true if the attribute is annotated with
at least one of the provided annotations.AttributeBinder.bind(Object, java.util.Map, Class, Class...).AttributeDescriptor.key,
AttributeDescriptor.type, AttributeDescriptor.defaultValue and AttributeDescriptor.constraints.AttributeDescriptors into their keys.Attribute.key().
Attributes.AttributeValueSet with a null description
and a null base attribute value set.
AttributeValueSet with a null description.
AttributeValueSet.
AttributeValueSets and provides methods for
serializing and deserializing attribute value sets from XML streams.Processing and Input
annotations have been bound, but before a call to IProcessingComponent.process().
Attribute values on the
provided instance.
AttributeBinder.bind(Object, Map, Class, Class...) that can optionally skip
Required attribute checking.
AttributeBinder.bind(Object, Map, boolean, Class, Class...) with a
AttributeBinder.FilteringAnnotationsPredicate instead of filtering annotations.
AttributeBinder.bind(Object, Map, Class, Class...) that accepts
custom AttributeBinder.IAttributeBinderActions.
AttributeBinder.bind(Object, Map, Class, Class...) that accepts
custom AttributeBinder.IAttributeBinderActions.
AttributeBinder.Bindable type, including
AttributeDescriptors for all attributes defined by the type.AttributeDescriptor grouping methods.BindableDescriptors based on the provided bindable type instances.Bindable type.Bindable.IDocumentSource fetching Documents (search results) from Yahoo BOSS.BindableDescriptor for an initialized instance of a
Bindable type.
BindableDescriptorBuilder.buildDescriptor(Object) that allows to skip loading metadata
for the descriptors.
allDocument that were not referenced in any cluster in
clusters.
allDocument that were not referenced in any cluster in
clusters.
context,
stores the result in there.
context,
stores the result in there.
Documents by their identifiers Document.getId(), which effectively
gives the original order in which they were returned by the document source.
Cluster.getLabel().
Cluster.SCORE and labels as
returned by Cluster.getLabel().
Cluster.size() and labels as
returned by Cluster.getLabel().
Cluster.SCORE.
Cluster.size().
byte [][] arrays.ControllerFactory.createCachingPooling(Class...) to
obtain a Controller equivalent to this one. Controllers can
be further tuned with custom IProcessingComponentManagers. This
class will be removed in the 3.4.0 release of Carrot2.IProcessingComponentManager that implements processing results caching
functionality.CachingProcessingComponentManager.
ISequence wrapper for any CharSequence.char [] arrays.char [] arrays.char [] arrays.char [][] arrays.CharSequences.value can be assigned to the type defined by
clazz.
fields of all
documents in the provided response.
Closeable, ignoring the exception if any.
Closeable, ignoring exceptions.
Connection, ignoring the exception if any.
Connections, ignoring exceptions.
Statement, ignoring the exception if any.
Statements, ignoring exceptions.
Closeable).Documents.Cluster with an empty label, no documents and no subclusters.
Cluster with the provided phrase to be used as the
cluster's label and documents contained in the cluster.
Cluster to add information about the cluster's parent cluster, if any.Collections.BindableMetadata and AttributeMetadata.Templates from a given system identifier.
Templates from a given stream.
IProcessingComponent class.
A, requires that NNI is available.
A, uses NNI if possible.
A as a fraction of non-zero elements to
the total number of elements.
ConstraintViolationException.
true if the urlTemplate contains the
attributePlaceholderName.
IProcessingComponent.IProcessingComponentManager, for experts
only.
IControllerContextListener.Controllers in a number of common configurations.Controller.annotations.
MultipageSearchEngine.SearchEngineResponseCallable instance that
fetches search results in the given range.
NameValuePair with request parameters.
NameValuePair with request parameters.
NameValuePair (parameters for the request).
NameValuePair with request parameters.
NameValuePair with request parameters.
NameValuePair (parameters for the request).
NameValuePair with request parameters.
RandomSeedingStrategy with constant seed.
ISeedingStrategy.
ILanguageModel objects.ILanguageModel objects.IResourceLocators.
ResourceUtils.
ProcessingResult from an XML stream.
AttributeValueSets from an XML stream.
BossImageSearchService.dimensions.Directory.
title.
title and summary.
title, summary and
language.
title, summary and
contentUrl.
title, summary,
contentUrl and language.
Document to its identifier returned by
Document.getId().PreprocessingContext.documents.
PreprocessingContext.documents.
IDocumentSource being part of a ProcessingComponentSuite.double [] arrays.DoubleComparators.DoubleRange.min() (inclusively) and
DoubleRange.max() (inclusively).ShortPredicate returning true
if the argument equals a given value.
ShortPredicate returning true
if the argument equals a given value.
EToolsDocumentSource, see
EToolsDocumentSource.country.EToolsDocumentSource,
see EToolsDocumentSource.dataSources.EToolsDocumentSource, see
EToolsDocumentSource.language.TransformerException as RuntimeException (wrapped).
Throwables.Executors framework.context.
context.
A.
OpenSearchDocumentSource.feedUrlTemplate on each request.
IFieldMapper provides the link between Carrot2 Document fields and
Lucene index fields.
BossWebSearchService.filter.id.
id.
state, labeled with a given symbol.
SuffixTree.NO_EDGE if a
given state has no edges.
PreprocessingContext.AllLabels.featureIndex which
points to PreprocessingContext.AllPhrases, or -1 if there are no phrases
in PreprocessingContext.AllLabels.featureIndex.
PreprocessingContext.AllLabels.featureIndex which
points to PreprocessingContext.AllPhrases, or -1 if there are no phrases
in PreprocessingContext.AllLabels.featureIndex.
IntIntOpenHashMap into a flat int [] array.
LanguageCode constant for a given ISO code (or null)
if not available.
PreprocessingContext.allLabels and can be used in algorithms that do not
use the full preprocessing pipeline.
PreprocessingContext.allLabels and can be used in algorithms that do not
use the full preprocessing pipeline.
sequence.
FSDirectory for serialization with SimpleXML.IResource.
key.
key.
AttributeValueSet and all other
AttributeValueSets that this set is based on.
AttributeValueSet or
null if the provided AttributeValueSet is null.
AttributeValueSet corresponding to the provided id
or null if no AttributeValueSet corresponds to the
id.
AttributeValueSet corresponding to the provided id
or the default AttributeValueSet (possibly null) if no
AttributeValueSet corresponds to the id.
AttributeValueSets in this collection.
AttributeValueSets from this collection that are based,
directly or indirectly, on the provided baseAttributeValueSet.
BindableDescriptor for an instance of this
descriptor's IProcessingComponent, with default Init attributes
initialized with the default attribute set.
BindableDescriptor for an instance of this
descriptor's IProcessingComponent, with default Init attributes
initialized with the default attribute set.
Document.CONTENT_URL field.
IControllerContext passed in ProcessingComponentBase.init(IControllerContext).
AttributeValueSet of this AttributeValueSets or
the first available AttributeValueSet if
AttributeValueSets.getDefaultAttributeValueSetId() is null.
AttributeValueSet within this
AttributeValueSets.
DoubleFactory2D to be used to construct result matrices.
PreprocessingContext.allLabels.
ResourceUtils.getFirst(String, Class) but without the clazz argument.
null if
the attribute is not assigned to any group.
ProcessingResult.
Throwable) or null.
Attribute.key().
null, otherwise returns title.
Document.LANGUAGE.
IntArrayPredicateIterator.next().
null if the
attribute has no level assigned.
ISeedingStrategyFactory used by this factory.
Document.SOURCES field.
Document.SUMMARY field.
Document.TITLE field.
IDocumentSource fetching search results from Google JSON API.BindableDescriptor is grouped.
v1 and v2, giving both
arguments equal weight.
v1 and v2, weighting them by
w1 and w2, respectively.
true if the input array contains any capitalized
characters.
true if this context contains any label candidates.
true if this context contains any label candidates.
true if this context contains any words.
true if this context contains any words.
HttpClient with desired socket configuration settings.ControllerFactory to obtain a suitably configured
Controller. Controllers can be further tuned with custom
IProcessingComponentManagers. This interface will be removed
in the 3.4.0 release of Carrot2.Controller instance.IControllerContext.Document fields.ILanguageModel implementations.ILanguageModel implementations.IStemmer, may not correspond to any
correct word.
IStemmer, may not correspond to any
correct word.
IMatrixFactorizations.ImplementingClasses.classes().false, the start position of the search is determined by the
result index, which is the case for most search engines.
Init-time attributes map.
Init-time attributes.
Init-time attributes and
additional component-specific Init-time attributes.
Init and Input
annotations have been bound, but before calls to any other methods of this
component.
Controller.
AttributeBinder.True if the attribute is an Input attribute.
true.ISequence wrapper for an array of integers.AttributeDescriptor refers to an
Internal attribute.true for attributes that have the Internal
annotation, no matter the Internal.configuration() value.
true for attributes that have the Internal
annotation whose Internal.configuration() is set to the provided value.
int [][] arrays.IntIntOpenHashMaps.attributeValue % IntModulo.modulo() == IntModulo.offset().IntRange.min() (inclusively) and
IntRange.max() (inclusively).Controller.true if there is an arc connecting vertexA
and vertexB.
true if ITokenTypeAttribute.TF_COMMON_WORD is set.
true if ITokenTypeAttribute.TF_COMMON_WORD is set.
true if the given type has ITokenTypeAttribute.TF_SEPARATOR_DOCUMENT set.
true if the given type has ITokenTypeAttribute.TF_SEPARATOR_DOCUMENT set.
ISeedingStrategy
interface.true if this metric should be calculated.
delta on each
element.
SuffixTree can be built.File and the path denoted
by it is actually a file.state is a leaf (has no outgoing edges).
value meets this constraint.
value meets the constraints defined by the
provided constraintAnnotations.
true if the native implementation of the BLAS package has been
successfully initialized.
true if the native implementation of the LAPACK package has
been successfully initialized.
true when the factorization is set to generate an ordered
basis.
true if this cluster is the Cluster.OTHER_TOPICS cluster.
true if the given value is valid for the attribute described
by this descriptor (non-null for Required attributes and
fulfilling all other constraints).
DenseDoubleMatrix2D is a view.
PreprocessingContext.allTokens.
PreprocessingContext.allTokens.
IMatrixFactorizations.delim and return it
as a string.
Attribute.key().
Attribute as defined in Attribute.key().
KMeansMatrixFactorization factory.DefaultLanguageModelFactory.AttributeDescriptor belongs to any of the
provided levels.Lists.ProcessingResult from the provided remote URL, applying XSLT
transform if specified.
ProcessingResult from the provided InputStream, applying
XSLT transform if specified.
IResource.
LocalNonnegativeMatrixFactorization factory.Document will have an additional
field named like this constant, pointing to the original
Lucene Document.
IDocumentSource fetching Documents from a local Apache Lucene index.Document instance.
Maps.context.
context.
DoubleMatrix2D shorthands and utility methods.A.
Bindable type.
IDocumentSource fetching Documents (search results) from Microsoft
Live!.PreprocessingContext.AllWords arrays, to the most frequent original form of
the stem.
PreprocessingContext.AllWords arrays, to the most frequent original form of
the stem.
IDocumentSources wrapping external
search engines with remote/ network-based interfaces.Callable that increments page request count statistics
before the actual search is made.MultipageSearchEngine characteristics.MultipageSearchEngineMetadata.incrementByPage set to
false.
CharSequence over a mutable char[] buffer.CharSequence over a mutable char[] buffer.MutableCharArray.
MutableCharArray from another CharSequence.
MutableCharArray.
MutableCharArray from another CharSequence.
int in their natural order.
Transformer.
TransformerHandler based on a given precompiled
Templates.
SuffixTree.NO_EDGE if
edge is the last edge in its state.
DoubleMatrix2D
based on the Native Numerical Interface (NNI).SuffixTree.transitions.
NonnegativeMatrixFactorizationEDs.NonnegativeMatrixFactorizationKLs.URIResolver.context.
context.
A so that their L1 norm is equal
to 1.0.
A so that their L2 norm (Euclidean
distance) is equal to 1.0.
A so that their L2 norm
(Euclidean distance) is equal to 1.0.
CharSequence value is not blank, i.e.Writer methods.
i (the first element
has 0 index).
predicate returns
true.
IDocumentSource fetching Documents (search results) from an
OpenSearch feed.Cluster.OTHER_TOPICS clusters at the end of the list.
AttributeBinder.True if the attribute is an Output attribute.
ClusterWithParent.cluster, may be null in case of
top-level clusters.
PartialSingularValueDecompositions.Formatter interface that doesn't
do any highlighting and just returns the original text.IProcessingComponentManager that pools instances of processing components.PoolingProcessingComponentManager using the default pool
implementation SoftUnboundedPool).
PoolingProcessingComponentManager with a custom pool
implementation.
state is fully traversed.
state is descended into.
stream, closing it at the end.
Bindable this descriptor refers to, as returned by
BindableUtils#getPrefix(Class).
PreprocessingContext.
PreprocessingContext.
PreprocessingContext.
PreprocessingContext.
PreprocessingContext.PreprocessingContext.documents and with
the provided languageModel.
documents and with
the provided languageModel.
PreprocessingContext.documents.PreprocessingContext.documents.PreprocessingContext.documents.PreprocessingContext.documents.PreprocessingContext.documents.PreprocessingContext.documents.PreprocessingContext.documents.PreprocessingContext.documents.PreprocessingContext.documents.PreprocessingContext.documents.LingoClusteringAlgorithm.documents.
STCClusteringAlgorithm.documents.
IProcessingComponent.
documents to the set of
returned documents.
documents assuming they are written in language.
documents assuming they are written in language.
IProcessingComponent interface that
provides empty implementations of all life cycle methods.IProcessingComponent.IProcessingComponent being part of a
ProcessingComponentSuite.ProcessingComponentDescriptor to its identifier.IProcessingComponents used in Carrot2 applications.Query object or a String parsed using the built-in
QueryParser over a set of search fields returned from the
LuceneDocumentSource.fieldMapper.
null
null
true, all documents are read from the input XML stream, regardless
of the limit set by XmlDocumentSource.results.
IResourceLocator from the list of existing default locators.
AttributeValueSet corresponding to the provided id
from this collection.
IControllerContextListener from this context.
True if the attribute is a Required attribute.
ResourceUtils.XmlDocumentSource.readAll is
false.
int in their reversed order.
IDocumentSources wrapping external
search engines with remote/ network-based interfaces.MultipageSearchEngine.MultipageSearchEngine.createFetcher(SearchRange)
are called.
ProcessingResult to an XML stream.
ProcessingResult to a byte stream.
AttributeValueSets to an XML stream.
writer.
writer.
writer.
writer.
value corresponding to the provided key in this
attribute value set.
values to this attribute value set.
Document.CONTENT_URL field.
AttributeValueSets.
doubleFactory2D to be used by this factory.
factory.
Document.LANGUAGE.
true to generate an ordered basis.
Cluster.OTHER_TOPICS attribute of this cluster.
TokenTypeAttributeImpl.flags.
TokenTypeAttributeImpl.flags.
Cluster.SCORE field.
ISeedingStrategyFactory to be used by this factory.
Document.SOURCES field.
Document.SUMMARY field.
Document.TITLE field.
Sets.ControllerFactory.createSimple() to obtain a
Controller equivalent to this one. Controllers can be
further tuned with custom IProcessingComponentManagers. This class
will be removed in the 3.4.0 release of Carrot2.IFieldMapper with one-to-one mapping between the default title, url and
summary fields.IProcessingComponentManager that creates a new component for each processing
request.IDocumentSources wrapping external
search engines with remote/ network-based interfaces.ILabelFilter implementations that handle each label independently.ILabelFilter implementations that handle each label independently.ControllerStatistics.sourceTimeWindowSize.
ControllerStatistics.sourceTimeWindowSize.
StandardAnalyzer with
a parameterless constructor defining the compatibility flag
to the version (Version.LUCENE_30).null if the base form
cannot be determined.
null if the base form
cannot be determined.
context.
context.
PreprocessingContext.AllStems arrays for this word.
PreprocessingContext.AllStems arrays for this word.
tdMatrix.
tdMatrix.
Strings that are not available
in StringUtils.ErrorListener that reacts to errors when parsing (compiling) the stylesheet.ClusterWithParent.cluster wrapped to add their parent cluster.
SuffixTree.A.
Templates).TemplatesPool with caching enabled.
PreprocessingContext.PreprocessingContext.PreprocessingContext.AllLabels.
PreprocessingContext.AllLabels.
SAXTransformerFactory capable of producing SAX-based transformers.
LanguageCodes.
CharSequence into a char [] array.
context.
context.
ITokenTypeAttribute.ITokenTypeAttribute.ITokenTypeAttributes.ITokenTypeAttributes.LanguageCode or null if no
LanguageCode corresponds to this BossLanguageCodes constant.
LanguageCode or null if no
LanguageCode corresponds to this EToolsDocumentSource.Language constant.
LanguageCode or null if no
LanguageCode corresponds to this CultureInfo constant.
buffer.
ControllerStatistics.totalTimeWindowSize.
ControllerStatistics.totalTimeWindowSize.
ErrorListener that reacts to errors when transforming (applying) a
stylesheet.ITokenTypeAttribute bit flags.
ITokenTypeAttribute bit flags.
PreprocessingContext.AllTokens.type.
PreprocessingContext.AllTokens.type.
BindableDescriptor refers to.
AttributeBinder.bind(Object, Map, Class, Class...) method.
map and for values being String
arrays puts the first element of the map in the result map.
IResource implementation that allows URLs to be parameterized.url;
String.IValueHintMapping and Enum classes.PreprocessingContext.AllWords arrays for this token.
PreprocessingContext.AllWords arrays for this token.
PreprocessingContext.AllWords for each word in the phrase sequence.
PreprocessingContext.AllWords for each word in the phrase sequence.
root into
ClusterWithParent objects.
t if an instance of clazz, then t is
returned.
ExceptionUtils.wrapAs(Class, Throwable) with the first parameter set to
RuntimeException.
IDocumentSource based on XML/XSLT is likely
to need.IDocumentSource fetching Documents (search results) from Yahoo!.YSearchResponse.
|
Please refer to project documentation at
http://project.carrot2.org |
||||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||||