MultipageSearchEngineDescriptor (Carrot2 v3.5.2 API Documentation (JavaDoc))

Overview

Package

Class

Tree

Deprecated

Index

Help

Carrot² v3.5.2
API Documentation

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.carrot2.source
Class MultipageSearchEngineDescriptor

java.lang.Object
  org.carrot2.source.MultipageSearchEngineDescriptor

All Implemented Interfaces:: IBindableDescriptor

@Generated(value="Generated from org.carrot2.source.MultipageSearchEngine") public final class MultipageSearchEngineDescriptor
extends Object
implements IBindableDescriptor
extends Object
implements IBindableDescriptor

Metadata and attributes of the MultipageSearchEngine component. You can use this descriptor to obtain metadata, such as human readable name and description, about the component as a whole as well as about its attributes. Using the attributeBuilder(Map) you can obtain a builder for type-safe generation of the attribute maps. Please see the main overview for a complete code example.

Nested Class Summary
`static class`	`MultipageSearchEngineDescriptor.AttributeBuilder` Attribute map builder for the `MultipageSearchEngine` component.
`static class`	`MultipageSearchEngineDescriptor.Attributes` All attributes of the `MultipageSearchEngine` component.
`static class`	`MultipageSearchEngineDescriptor.Keys` Constants for all attribute keys of the `MultipageSearchEngine` component.

Field Summary
`static MultipageSearchEngineDescriptor.Attributes`	`attributes` Attributes of the component.
`String`	`bindableClassName` The component class for which this descriptor was generated.
`String`	`description` A longer, possibly multi sentence, description of the component.
`String`	`label` A short label for the component.
`String`	`prefix` Attribute prefix used by the component.
`String`	`title` A one sentence summary of the component.

Constructor Summary
`MultipageSearchEngineDescriptor()`

Method Summary
`static MultipageSearchEngineDescriptor.AttributeBuilder`	`attributeBuilder(Map<String,Object> attributeValues)` Creates an attribute map builder for the component.
`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.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

bindableClassName

public final String bindableClassName

The component class for which this descriptor was generated.

See Also:: Constant Field Values

prefix

public final String prefix

Attribute prefix used by the component.

See Also:: Constant Field Values

title

public final String title

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

See Also:: Constant Field Values

label

public final String label

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

See Also:: Constant Field Values

description

public final String description

A longer, possibly multi sentence, description of the component. It could be presented as a body of the tool tip of the corresponding UI component.

See Also:: Constant Field Values

attributes

public static final MultipageSearchEngineDescriptor.Attributes attributes

Attributes of the component. Note that only statically reachable fields are included. Additional attributes may be available at run time.

Constructor Detail

MultipageSearchEngineDescriptor

public MultipageSearchEngineDescriptor()

Method Detail

attributeBuilder

public static MultipageSearchEngineDescriptor.AttributeBuilder attributeBuilder(Map<String,Object> attributeValues)

Creates an attribute map builder for the component. You can use this builder as a type-safe alternative to populating the attribute map using attribute keys.

Parameters:: attributeValues - An existing map which should be used to collect attribute values. Attribute values set by this builder will be added to the provided map, overwriting previously defined mappings, if any.