org.protempa.GapFunction 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 org.protempa.proposition.AbstractParameter;
import org.protempa.proposition.TemporalProposition;
import org.protempa.proposition.interval.Interval;
import org.protempa.proposition.Segment;

/**
 * A convenience class for implementing gap functions. In PROTEMPA, gap 
 * functions describe whether information inferred or data recorded during two
 * separate intervals should also be true during the gap between the 
 * two intervals. If a pair of intervals of the same type satisfy the 
 * gap function, PROTEMPA replaces them with a single interval that spans the 
 * two original intervals and the gap between them.
 * 
 * To implement a gap function, override
 * {@link #execute(org.protempa.proposition.interval.Interval, org.protempa.proposition.interval.Interval) }
 * with the implementation of your function. Gap functions only apply to
 * {@link AbstractParameter} propositions. A default concrete implementation is
 * provided, {@link SimpleGapFunction}, an instance of which is assigned to
 * the static variable {@link #DEFAULT}.
 * 
 * @author Andrew Post
 */
public abstract class GapFunction implements Serializable {
    
    private static final long serialVersionUID = -2463785054444632104L;
    public static final GapFunction DEFAULT = new SimpleGapFunction();

    /**
     * Returns whether two abstract parameters have a gap that satisfies
     * the constraints of the gap function. If either provided parameter is
     * null, this method returns false.
     * 
     * @param lhs the first {@link AbstractParameter}.
     * @param rhs the second {@link AbstractParameter}.
     * @return true or false.
     */
    public final boolean execute(TemporalProposition lhs, 
            TemporalProposition rhs) {
        if (lhs == null || rhs == null) {
            return false;
        } else {
            return execute(lhs.getInterval(), rhs.getInterval());
        }
    }

    /**
     * Returns whether two segments have a gap that satisfies
     * the constraints of the gap function. If either provided segment is
     * null, this method returns false.
     * 
     * @param lhs the first {@link Segment}.
     * @param rhs the second {@link Segment}.
     * @return true or false.
     */
    final boolean execute(Segment lhs, Segment rhs) {
        if (lhs == null || rhs == null) {
            return false;
        } else {
            return execute(lhs.getInterval(), rhs.getInterval());
        }
    }

    /**
     * Returns whether two intervals have a gap that satisfies
     * the constraints of the gap function. To be overridden by the actual
     * implementation of the gap function.
     * 
     * @param lhs the first {@link Interval}.
     * @param rhs the second {@link Interval}.
     * @return true or false.
     */
    public abstract boolean execute(Interval lhs, Interval rhs);
}