All Downloads are FREE. Search and download functionalities are using the official Maven repository.

uno.informatics.data.Scale Maven / Gradle / Ivy

/*******************************************************************************
 * Copyright 2016 Guy Davenport
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************/

package uno.informatics.data;

import java.util.List;
import java.util.Set;

public interface Scale extends Entity {
    /**
     * Gets the maximum value in the scale
     * 
     * @return the maximum value in the scale, or null if the
     *         maximum value is not applicable, e.g. for nominal scales
     */
    public Number getMaximumValue();

    /**
     * Gets the minimum value in the scale
     * 
     * @return the minimum value in the scale, or null if the
     *         maximum value is not applicable, e.g. for nominal scales
     */
    public Number getMinimumValue();

    /**
     * Gets all possible values for this scale. Values can not be repeated. The
     * order of the values is important for Ordinal scales
     * 
     * @return all possible values for this scale, or null the
     *         number of possible values is large or infinite, e.g. for ratio
     *         and interval scales
     */
    public List getValues();

    /**
     * Gets the data type for this scale
     * 
     * @return the data type for this scale
     */
    public DataType getDataType();

    /**
     * Gets the scale type for this scale
     * 
     * @return the scale type for this scale
     */
    public ScaleType getScaleType();
}