org.datacleaner.api.ComponentSuperCategory Maven / Gradle / Ivy

Go to download
/**
 * DataCleaner (community edition)
 * Copyright (C) 2014 Neopost - Customer Information Management
 *
 * This copyrighted material is made available to anyone wishing to use, modify,
 * copy, or redistribute it subject to the terms and conditions of the GNU
 * Lesser General Public License, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this distribution; if not, write to:
 * Free Software Foundation, Inc.
 * 51 Franklin Street, Fifth Floor
 * Boston, MA  02110-1301  USA
 */
package org.datacleaner.api;

import java.io.Serializable;

import org.apache.metamodel.util.HasName;

/**
 * Represents a "super category" of components. Where {@link ComponentCategory}
 * represents the groupings of related components, the super categorization is
 * used for representing broader categories of components such as
 */
public interface ComponentSuperCategory extends Serializable, HasName, Comparable {

    /**
     * Gets the name of the category. The name is often used as the primary
     * identifier of a category.
     *
     * @return a string name
     */
    @Override
    String getName();

    /**
     * Gets the description of the category.
     *
     * @return
     */
    String getDescription();

    /**
     * Gets an index for sorting of {@link ComponentSuperCategory} objects. Any
     * value is valid. The sequence of numbers will guide how a presentation of
     * categories will be sorted.
     *
     * @return
     */
    int getSortIndex();
}