org.semanticweb.HermiT.tableau.InterruptFlag Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.semanticweb.hermit Show documentation

HermiT is reasoner for ontologies written using the Web Ontology Language (OWL). Given an OWL file, HermiT can determine whether or not the ontology is consistent, identify subsumption relationships between classes, and much more. This is the maven build of HermiT and is designed for people who wish to use HermiT from within the OWL API. It is now versioned in the main HermiT version repository, although not officially supported by the HermiT developers. The version number of this package is a composite of the HermiT version and a value representing the OWLAPI release it is compatible with. Note that the group id for the upstream HermiT is com.hermit-reasoner, while this fork is released under net.sourceforge.owlapi. This fork exists to allow HermiT users to use newer OWLAPI versions than the ones supported by the original HermiT codebase. This package includes the Jautomata library (http://jautomata.sourceforge.net/), and builds with it directly. This library appears to be no longer under active development, and so a "fork" seems appropriate. No development is intended or anticipated on this code base.

The newest version!

/* Copyright 2009 by the Oxford University Computing Laboratory

   This file is part of HermiT.

   HermiT is free software: you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published by
   the Free Software Foundation, either version 3 of the License, or
   (at your option) any later version.

   HermiT is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with HermiT.  If not, see .
 */
package org.semanticweb.HermiT.tableau;

import java.io.Serializable;

import org.semanticweb.owlapi.reasoner.ReasonerInterruptedException;
import org.semanticweb.owlapi.reasoner.TimeOutException;
/**InterruptFlag.*/
public final class InterruptFlag implements Serializable {
    private static final long serialVersionUID=-6983680374511847003L;

    protected static enum InterruptType { INTERRUPTED,TIMEOUT }

    protected final InterruptTimer m_interruptTimer;
    protected volatile InterruptType m_interruptType;

    /**
     * @param individualTaskTimeout individualTaskTimeout
     */
    public InterruptFlag(long individualTaskTimeout) {
        if (individualTaskTimeout>0)
            m_interruptTimer=new InterruptTimer(individualTaskTimeout);
        else
            m_interruptTimer=null;
    }
    /**Check interrupt.*/
    public void checkInterrupt() {
        InterruptType interruptType=m_interruptType;
        if (interruptType!=null) {
            if (interruptType==InterruptType.TIMEOUT)
                throw new TimeOutException();
            else
                throw new ReasonerInterruptedException();
        }
    }
    /**Interrupt.*/
    public void interrupt() {
        m_interruptType=InterruptType.INTERRUPTED;
    }
    /**Start task. */
    public void startTask() {
        m_interruptType=null;
        if (m_interruptTimer!=null)
            m_interruptTimer.startTiming();
    }
    /**End task. */
    public void endTask() {
        if (m_interruptTimer!=null)
            m_interruptTimer.stopTiming();
        m_interruptType=null;
    }
    /**Dispose.*/
    public void dispose() {
        if (m_interruptTimer!=null)
            m_interruptTimer.dispose();
    }

    protected static enum TimerState { WAIT_FOR_TASK,TIMING,TIMING_STOPPED,DISPOSED }

    protected class InterruptTimer extends Thread {
        protected final long m_timeout;
        protected TimerState m_timerState;

        public InterruptTimer(long timeout) {
            super("HermiT Interrupt Current Task Thread");
            setDaemon(true);
            m_timeout=timeout;
            start();
        }
        @SuppressWarnings("unused")
        @Override
        public synchronized void run() {
            while (m_timerState!=TimerState.DISPOSED) {
                m_timerState=TimerState.WAIT_FOR_TASK;
                notifyAll();
                while (m_timerState==TimerState.WAIT_FOR_TASK) {
                    try {
                        wait();
                    }
                    catch (InterruptedException stopped) {
                        m_timerState=TimerState.DISPOSED;
                    }
                }
                if (m_timerState==TimerState.TIMING) {
                    try {
                        wait(m_timeout);
                        if (m_timerState==TimerState.TIMING)
                            m_interruptType=InterruptType.TIMEOUT;
                    }
                    catch (InterruptedException stopped) {
                        m_timerState=TimerState.DISPOSED;
                    }
                }
            }
        }
        @SuppressWarnings("unused")
        public synchronized void startTiming() {
            while (m_timerState!=TimerState.WAIT_FOR_TASK && m_timerState!=TimerState.DISPOSED) {
                try {
                    wait();
                }
                catch (InterruptedException stopped) {
                }
            }
            if (m_timerState==TimerState.WAIT_FOR_TASK) {
                m_timerState=TimerState.TIMING;
                notifyAll();
            }
        }
        public synchronized void stopTiming() {
            if (m_timerState==TimerState.TIMING) {
                m_timerState=TimerState.TIMING_STOPPED;
                notifyAll();
                while (m_timerState!=TimerState.WAIT_FOR_TASK && m_timerState!=TimerState.DISPOSED) {
                    try {
                        wait();
                    }
                    catch (@SuppressWarnings("unused") InterruptedException stopped) {
                        return;
                    }
                }
            }
        }
        public synchronized void dispose() {
            m_timerState=TimerState.DISPOSED;
            notifyAll();
            try {
                join();
            }
            catch (@SuppressWarnings("unused") InterruptedException e) {
            }
        }
    }
}