org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithmDescriptor Maven / Gradle / Ivy
Show all versions of carrot2-mini Show documentation
// APT-generated file.
package org.carrot2.clustering.synthetic;
//Imported for JavaDoc references mostly.
import org.carrot2.util.attribute.*;
import java.util.*;
import javax.annotation.*;
/**
* Metadata and attributes of the {@link org.carrot2.clustering.synthetic.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 {@link #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.
*/
@Generated("Generated from org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm")
public final class ByUrlClusteringAlgorithmDescriptor implements IBindableDescriptor
{
/**
* The component class for which this descriptor was generated.
*/
public final String bindableClassName = "org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm";
/**
* Attribute prefix used by the component.
*/
public final String prefix = "";
/**
* A one sentence summary of the component. It could be presented as a header of the tool
* tip of the corresponding UI component.
*/
public final String title = "Hierarchically clusters documents according to their content URLs";
/**
* A short label for the component. It can be presented as a label of the
* corresponding UI component.
*/
public final String label = "By URL Clustering";
/**
* 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.
*/
public final String description = "Document.CONTENT_URL property will be used to obtain a document's URL. Groups at the top level of the hierarchy will correspond to the last segments of the URLs, usually domain suffixes, such as \".com\" or \".co.uk\". Subgroups will be created based on further segments of the URLs, very often domains subdomains, e.g. \"yahoo.com\", \"bbc.co.uk\" and then e.g. \"mail.yahoo.com\", \"news.yahoo.com\". The \"www\" segment of the URLs will be ignored.
Clusters will be ordered by size (number of documents) descendingly; in case of equal sizes, alphabetically by URL, see Cluster.BY_REVERSED_SIZE_AND_LABEL_COMPARATOR.";
/**
* Attributes of the component. Note that only statically reachable fields are included.
* Additional attributes may be available at run time.
*/
public final static Attributes attributes;
/**
* Attributes declared directly by the component.
*/
private final static Set ownAttributes;
/**
* Attributes declared by the component or its superclasses.
*/
private final static Set allAttributes;
/**
* Attributes declared by the component or its superclasses, lookup dictionary
* by attribute key.
*/
private final static Map allAttributesByKey;
/**
* Attributes declared by the component or its superclasses, lookup dictionary by
* attribute's field name.
*/
private final static Map allAttributesByFieldName;
/**
* Static initializer for internal collections.
*/
static
{
attributes = new Attributes();
final Set ownAttrs = new HashSet();
ownAttrs.add(attributes.documents);
ownAttrs.add(attributes.clusters);
final Set allAttrs = new HashSet();
allAttrs.add(org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithmDescriptor.attributes.documents);
allAttrs.add(org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithmDescriptor.attributes.clusters);
allAttributes = Collections.unmodifiableSet(allAttrs);
ownAttributes = Collections.unmodifiableSet(ownAttrs);
final Map allAttrsByKey = new HashMap();
final Map allAttrsByFieldName = new HashMap();
for (AttributeInfo ai : allAttrs)
{
allAttrsByKey.put(ai.key, ai);
allAttrsByFieldName.put(ai.fieldName, ai);
}
allAttributesByKey = Collections.unmodifiableMap(allAttrsByKey);
allAttributesByFieldName = Collections.unmodifiableMap(allAttrsByFieldName);
}
/* Attribute keys. */
/**
* Constants for all attribute keys of the {@link org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm} component.
*/
public static class Keys
{
protected Keys() {}
/** Attribute key for: {@link org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm#documents}. */
public static final String DOCUMENTS = "documents";
/** Attribute key for: {@link org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm#clusters}. */
public static final String CLUSTERS = "clusters";
}
/* Attribute descriptors. */
/**
* All attributes of the {@link org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm} component.
*/
public static final class Attributes
{
private Attributes() { /* No public instances. */ }
/**
*
*
* @see org.carrot2.core.attribute.CommonAttributes#documents
*/
public final AttributeInfo documents =
new AttributeInfo(
"documents",
"org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm",
"documents",
"Documents to cluster.",
null,
"Documents to cluster",
null,
null,
null,
org.carrot2.core.attribute.CommonAttributesDescriptor.attributes.documents
);
/**
*
*
* @see org.carrot2.core.attribute.CommonAttributes#clusters
*/
public final AttributeInfo clusters =
new AttributeInfo(
"clusters",
"org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm",
"clusters",
"Clusters created by the algorithm.",
null,
"Clusters created by the algorithm",
null,
null,
null,
org.carrot2.core.attribute.CommonAttributesDescriptor.attributes.clusters
);
}
/**
* Attribute map builder for the {@link org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm} component. You can use this
* builder as a type-safe alternative to populating the attribute map using attribute keys.
*/
public static class AttributeBuilder
{
/** The attribute map populated by this builder. */
public final Map map;
/**
* Creates a builder backed by the provided map.
*/
protected AttributeBuilder(Map map)
{
this.map = map;
}
/**
* Documents to cluster.
*
* @see org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm#documents
*/
public AttributeBuilder documents(java.util.List value)
{
map.put("documents", value);
return this;
}
/**
* Documents to cluster.
*
* @see org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm#documents
*/
public AttributeBuilder documents(IObjectFactory> value)
{
map.put("documents", value);
return this;
}
/**
* Clusters created by the algorithm.
*
* @see org.carrot2.clustering.synthetic.ByUrlClusteringAlgorithm#clusters
*/
@SuppressWarnings("unchecked") public java.util.List clusters()
{
return (java.util.List) map.get("clusters");
}
}
/**
* 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.
*
* @param 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.
*/
public static AttributeBuilder attributeBuilder(Map attributeValues)
{
return new AttributeBuilder(attributeValues);
}
/* IBindableDescriptor */
@Override
public String getPrefix()
{
return prefix;
}
@Override
public String getTitle()
{
return title;
}
@Override
public String getLabel()
{
return label;
}
@Override
public String getDescription()
{
return description;
}
@Override
public Set getOwnAttributes()
{
return ownAttributes;
}
@Override
public Set getAttributes()
{
return allAttributes;
}
@Override
public Map getAttributesByKey()
{
return allAttributesByKey;
}
@Override
public Map getAttributesByFieldName()
{
return allAttributesByFieldName;
}
}