org.protempa.ExtendedParameterDefinition Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of protempa-framework Show documentation
Protempa Framework is the core of Protempa.
There is a newer version: 5.2-Alpha-2
/*
 * #%L
 * Protempa Framework
 * %%
 * Copyright (C) 2012 - 2013 Emory University
 * %%
 * 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.
 * #L%
 */
package org.protempa;

import java.util.Collection;
import org.protempa.proposition.Parameter;
import org.protempa.proposition.Proposition;
import org.protempa.proposition.value.Value;

/**
 * Represents an instance of an abstraction definition with optional constraints
 * on the instance's duration.
 *
 * @author Andrew Post
 */
public class ExtendedParameterDefinition extends ExtendedPropositionDefinition {

    private static final long serialVersionUID = -3587086756622794815L;

    private Value value;

    public ExtendedParameterDefinition(String parameterId) {
        super(parameterId);
    }

    public Value getValue() {
        return value;
    }

    /**
     * Returns whether a parameter has the same id and value, and consistent
     * duration as specified by this extended parameter definition.
     *
     * @param parameter a Parameter
     * @return true if parameter has the same id and
     * value, and consistent duration as specified by this extended parameter
     * definition, or false if not, or if parameter is
     * null.
     */
    @Override
    boolean getMatches(Proposition proposition, Collection propIds) throws KnowledgeSourceReadException {
        if (!super.getMatches(proposition, propIds)) {
            return false;
        }

        if (!(proposition instanceof Parameter)) {
            return false;
        }

        if (this.value != null) {
            Value pValue = ((Parameter) proposition).getValue();
            if (this.value != pValue && !this.value.equals(pValue)) {
                return false;
            }
        }

        return true;
    }

    public void setValue(Value value) {
        this.value = value;
    }

    @Override
    public boolean hasEqualFields(ExtendedPropositionDefinition obj) {
        if (!super.hasEqualFields(obj)) {
            return false;
        }

        if (!(obj instanceof ExtendedParameterDefinition)) {
            return false;
        }

        ExtendedParameterDefinition other = (ExtendedParameterDefinition) obj;
        return (value == other.value || value.equals(other.value));
    }

    @Override
    public String toString() {
        return "Extended parameter: " + this.getPropositionId() + "; " + value;
    }

}