org.carrot2.util.attribute
Interface IBindableDescriptor

All Known Implementing Classes:

AmbientDocumentSourceDescriptor, BasicPreprocessingPipelineDescriptor, Bing2DocumentSourceDescriptor, Bing2ImageDocumentSourceDescriptor, Bing2NewsDocumentSourceDescriptor, Bing2WebDocumentSourceDescriptor, BisectingKMeansClusteringAlgorithmDescriptor, ByFieldClusteringAlgorithmDescriptor, ByUrlClusteringAlgorithmDescriptor, CaseNormalizerDescriptor, ClusterBuilderDescriptor, ClusteringMetricsCalculatorDescriptor, CommonAttributesDescriptor, CompleteLabelFilterDescriptor, CompletePreprocessingPipelineDescriptor, ContaminationMetricDescriptor, DefaultLexicalDataFactoryDescriptor, DefaultStemmerFactoryDescriptor, DefaultTokenizerFactoryDescriptor, DocumentAssignerDescriptor, EToolsDocumentSourceDescriptor, FubDocumentSourceDescriptor, GenitiveLabelFilterDescriptor, GoogleDesktopDocumentSourceDescriptor, GoogleDocumentSourceDescriptor, IdealPartitioningBasedMetricDescriptor, IdolDocumentSourceDescriptor, LabelFilterProcessorDescriptor, LabelFormatterDescriptor, LanguageModelStemmerDescriptor, LexicalDataLoaderDescriptor, LingoClusteringAlgorithmDescriptor, LuceneDocumentSourceDescriptor, MinLengthLabelFilterDescriptor, MultilingualClusteringDescriptor, MultipageSearchEngineDescriptor, NormalizedMutualInformationMetricDescriptor, NumericLabelFilterDescriptor, Odp239DocumentSourceDescriptor, OpenSearchDocumentSourceDescriptor, PhraseExtractorDescriptor, PrecisionRecallMetricDescriptor, PubMedDocumentSourceDescriptor, QueryLabelFilterDescriptor, RemoteXmlSimpleSearchEngineBaseDescriptor, SearchEngineBaseDescriptor, SearchEngineStatsDescriptor, SimpleFieldMapperDescriptor, SimpleLabelAssignerDescriptor, SimpleSearchEngineDescriptor, SolrDocumentSourceDescriptor, STCClusteringAlgorithmDescriptor, StopLabelFilterDescriptor, StopListMarkerDescriptor, StopWordLabelFilterDescriptor, TermDocumentMatrixBuilderDescriptor, TermDocumentMatrixReducerDescriptor, TokenizerDescriptor, UniqueLabelAssignerDescriptor, XmlDocumentSourceDescriptor, XmlDocumentSourceHelperDescriptor

public interface IBindableDescriptor

Additional, statically derived, metadata describing a Bindable component.

Method Summary

Set<AttributeInfo>	getAttributes() Returns descriptors of attributes declared by the component or its superclasses.
Map<String,AttributeInfo>	getAttributesByFieldName() Returns descriptors of attributes declared by the component or its superclasses mapped by the field name.
Map<String,AttributeInfo>	getAttributesByKey() Returns descriptors of attributes declared by the component or its superclasses mapped by the attribute key.
String	getDescription() Returns a one sentence summary of the component.
String	getLabel() Returns a short label for the component.
Set<AttributeInfo>	getOwnAttributes() Returns descriptors of attributes declared directly by the component.
String	getPrefix() Returns the attribute prefix used by the component.
String	getTitle() Returns a one sentence summary of the component.

Method Detail

getPrefix

String getPrefix()

Returns the attribute prefix used by the component.

getTitle

String getTitle()

Returns a one sentence summary of the component. It could be presented as a header of the tool tip of the corresponding UI component.

getLabel

String getLabel()

Returns a short label for the component. It can be presented as a label of the corresponding UI component.

getDescription

String getDescription()

Returns a one sentence summary of the component. It could be presented as a header of the tool tip of the corresponding UI component.

getOwnAttributes

Set<AttributeInfo> getOwnAttributes()

Returns descriptors of attributes declared directly by the component.

getAttributes

Set<AttributeInfo> getAttributes()

Returns descriptors of attributes declared by the component or its superclasses.

getAttributesByKey

Map<String,AttributeInfo> getAttributesByKey()

Returns descriptors of attributes declared by the component or its superclasses mapped by the attribute key.

getAttributesByFieldName

Map<String,AttributeInfo> getAttributesByFieldName()

Returns descriptors of attributes declared by the component or its superclasses mapped by the field name.