org.protempa.ExtendedPropositionDefinition 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.io.Serializable;
import java.util.Collection;
import org.apache.commons.lang3.builder.ToStringBuilder;
import org.protempa.proposition.Proposition;

public class ExtendedPropositionDefinition implements Serializable {

    private static final long serialVersionUID = 3835638971180620664L;
    
    private static final PropertyConstraint[] EMPTY_PROP_CONSTRAINT_ARR =
            new PropertyConstraint[0];

    private String propositionId;

    private String displayName;

    private String abbreviatedDisplayName;

    private PropertyConstraint[] propertyConstraints;

    private volatile int hashCode;

    public ExtendedPropositionDefinition(String propositionId) {
        if (propositionId == null) {
            throw new IllegalArgumentException(
                    "A propositionId must be specified");
        }
        this.propositionId = propositionId;
        this.propertyConstraints = EMPTY_PROP_CONSTRAINT_ARR;
    }

    /**
     * @return the proposition id String.
     */
    public final String getPropositionId() {
        return this.propositionId;
    }

    public final void setPropertyConstraints(PropertyConstraint[] propertyConstraints) {
        if (propertyConstraints != null) {
            ProtempaUtil.checkArrayForNullElement(propertyConstraints, "propertyConstraints");
            this.propertyConstraints = propertyConstraints.clone();
        } else {
            this.propertyConstraints = EMPTY_PROP_CONSTRAINT_ARR;
        }
    }
    
    /**
     * @return the Set of property constraints
     */
    public final PropertyConstraint[] getPropertyConstraints() {
        return this.propertyConstraints.clone();
    }

    /**
     * Returns whether a proposition has the same id and value, and consistent
     * duration as specified by this extended parameter definition.
     * 
     * @param proposition
     *            a Proposition
     * @return true if proposition has the same id and
     *         value, consistent duration, and property values that match any
     *         property constraints as specified by this extended parameter
     *         definition, or false if not, or if
     *         proposition is null.
     */
    boolean getMatches(Proposition proposition, Collection propIds) throws KnowledgeSourceReadException {
        if (proposition == null) {
            return false;
        } else {
            String pId = proposition.getId();
            if (this.propositionId != null && !propIds.contains(pId)) {
                return false;
            }
            // check that all property constraints are met
            for (PropertyConstraint pc : this.propertyConstraints) {
                if (!pc.isSatisfiedBy(proposition)) {
                    return false;
                }
            }

            return true;
        }
    }

    public final String getDisplayName() {
        return this.displayName;
    }

    public final String getAbbreviatedDisplayName() {
        return this.abbreviatedDisplayName;
    }

    public final String getShortDisplayName() {
        String abbrevDisplayName = this.getAbbreviatedDisplayName();
        if (abbrevDisplayName != null && abbrevDisplayName.length() > 0) {
            return abbrevDisplayName;
        } else {
            return this.getDisplayName();
        }
    }

    public final void setAbbreviatedDisplayName(String abbreviatedDisplayName) {
        this.abbreviatedDisplayName = abbreviatedDisplayName;
    }

    public final void setDisplayName(String displayName) {
        this.displayName = displayName;
    }

    @Override
    public int hashCode() {
        if (this.hashCode == 0) {
            this.hashCode = super.hashCode();
        }
        return this.hashCode;
    }

    public boolean hasEqualFields(ExtendedPropositionDefinition obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }

        return propositionId.equals(obj.propositionId);
    }

    @Override
    public String toString() {
        return ToStringBuilder.reflectionToString(this);
    }
}