org.dkpro.tc.api.features.MissingValue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dkpro-tc-api-features Show documentation
There is a newer version: 1.1.0
Show newest version
/*******************************************************************************
 * Copyright 2015
 * Ubiquitous Knowledge Processing (UKP) Lab
 * Technische Universität Darmstadt
 * 
 * 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 org.dkpro.tc.api.features;

/**
 * Base class representing a feature value with a missing value.
 */
public class MissingValue
{

    private MissingValueType type;
    private Class> nominalClass;

    /**
     * Create a missing value for a non-nominal feature.
     * 
     * @param type
     *            numeric, boolean or string
     */
    public MissingValue(MissingValueNonNominalType type)
    {
        this.type = MissingValueType.valueOf(type.name());
    }

    /**
     * Create a missing value for a nominal feature.
     * 
     * @param clazz
     *            the enum class of the nominal feature value
     * @see MissingValue#MissingValue(Class)
     */
    public MissingValue(Class> clazz)
    {
        this.type = MissingValueType.NOMINAL;
        this.nominalClass = clazz;
    }

    /**
     * Gets the type of the feature for this missing value.
     * 
     * @return numeric, nominal, boolean or string
     */
    public MissingValueType getType()
    {
        return type;
    }

    /**
     * Gets the enum class of a nominal feature value.
     * 
     * @return an enum class
     */
    public Class> getNominalClass()
    {
        return nominalClass;
    }

    /**
     * Type of a feature: boolean, numeric, nominal, or string.
     * 
     */
    public enum MissingValueType
    {
        BOOLEAN, NUMERIC, STRING, NOMINAL
    }

    /**
     * Type of a non-nominal feature: boolean, numeric, or string.
     * 
     */
    public enum MissingValueNonNominalType
    {
        BOOLEAN, NUMERIC, STRING
    }

    @Override
    public boolean equals(Object obj)
    {
        if (obj instanceof MissingValue && ((MissingValue) obj).getType().equals(this.type)) {
            if (((MissingValue) obj).getType().equals(MissingValueType.NOMINAL)) {
                if (this.getNominalClass() != null
                        && this.getNominalClass().getSimpleName()
                                .equals(((MissingValue) obj).getNominalClass().getSimpleName())) {
                    return true;
                }
            }
            else {
                return true;
            }
        }
        return false;
    }
}