org.carrot2.clustering.synthetic

Class ByUrlClusteringAlgorithmDescriptor

java.lang.Object

org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithmDescriptor

All Implemented Interfaces:

org.carrot2.util.attribute.IBindableDescriptor

@Generated(value="Generated from org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm")
public final class ByUrlClusteringAlgorithmDescriptor
extends Object
implements org.carrot2.util.attribute.IBindableDescriptor

Metadata and attributes of the ByUrlClusteringAlgorithm 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

Nested Classes

Modifier and Type	Class and Description
static class	ByUrlClusteringAlgorithmDescriptor.AttributeBuilder Attribute map builder for the ByUrlClusteringAlgorithm component.
static class	ByUrlClusteringAlgorithmDescriptor.Attributes All attributes of the ByUrlClusteringAlgorithm component.
static class	ByUrlClusteringAlgorithmDescriptor.Keys Constants for all attribute keys of the ByUrlClusteringAlgorithm component.

Field Summary

Fields

Modifier and Type	Field and Description
static ByUrlClusteringAlgorithmDescriptor.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

Constructors

Constructor and Description
ByUrlClusteringAlgorithmDescriptor()

Method Summary

Methods

Modifier and Type	Method and Description
static ByUrlClusteringAlgorithmDescriptor.AttributeBuilder	attributeBuilder(Map<String,Object> attributeValues) Creates an attribute map builder for the component.
Set<org.carrot2.util.attribute.AttributeInfo>	getAttributes()
Map<String,org.carrot2.util.attribute.AttributeInfo>	getAttributesByFieldName()
Map<String,org.carrot2.util.attribute.AttributeInfo>	getAttributesByKey()
String	getDescription()
String	getLabel()
Set<org.carrot2.util.attribute.AttributeInfo>	getOwnAttributes()
String	getPrefix()
String	getTitle()

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 ByUrlClusteringAlgorithmDescriptor.Attributes attributes

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

Constructor Detail

ByUrlClusteringAlgorithmDescriptor

public ByUrlClusteringAlgorithmDescriptor()

Method Detail

attributeBuilder

public static ByUrlClusteringAlgorithmDescriptor.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.

getPrefix

public String getPrefix()

Specified by:

getPrefix in interface org.carrot2.util.attribute.IBindableDescriptor

getTitle

public String getTitle()

Specified by:

getTitle in interface org.carrot2.util.attribute.IBindableDescriptor

getLabel

public String getLabel()

Specified by:

getLabel in interface org.carrot2.util.attribute.IBindableDescriptor

getDescription

public String getDescription()

Specified by:

getDescription in interface org.carrot2.util.attribute.IBindableDescriptor

getOwnAttributes

public Set<org.carrot2.util.attribute.AttributeInfo> getOwnAttributes()

Specified by:

getOwnAttributes in interface org.carrot2.util.attribute.IBindableDescriptor

getAttributes

public Set<org.carrot2.util.attribute.AttributeInfo> getAttributes()

Specified by:

getAttributes in interface org.carrot2.util.attribute.IBindableDescriptor

getAttributesByKey

public Map<String,org.carrot2.util.attribute.AttributeInfo> getAttributesByKey()

Specified by:

getAttributesByKey in interface org.carrot2.util.attribute.IBindableDescriptor

getAttributesByFieldName

public Map<String,org.carrot2.util.attribute.AttributeInfo> getAttributesByFieldName()

Specified by:

getAttributesByFieldName in interface org.carrot2.util.attribute.IBindableDescriptor