com.ugos.JIProlog.engine
Class JIPEvent

java.lang.Object
  |
  +--com.ugos.JIProlog.engine.JIPEvent

Direct Known Subclasses:

JIPErrorEvent, JIPTraceEvent

public class JIPEvent

extends java.lang.Object

JIPEvent is used to notify an interpreter event occurred during the execution
JIPEventListeners receive a JIPEvent object in one of their methods depending on the type of event

Version:

1.8.x.x

Author:

Ugo Chirico 2000
Home Page : http://www.ugosweb.com/jiprolog

See Also:

JIPEventListener, JIPEventListener.openNotified(com.ugos.JIProlog.engine.JIPEvent), JIPEventListener.closeNotified(com.ugos.JIProlog.engine.JIPEvent), JIPEventListener.moreNotified(com.ugos.JIProlog.engine.JIPEvent), JIPEventListener.endNotified(com.ugos.JIProlog.engine.JIPEvent), JIPEventListener.solutionNotified(com.ugos.JIProlog.engine.JIPEvent), JIPEventListener.termNotified(com.ugos.JIProlog.engine.JIPEvent)

Field Summary

static int	ID_CLOSE ID of a Close Event
static int	ID_END ID of a End Event
static int	ID_MORE ID of a More Event
static int	ID_OPEN ID of an Open Event
static int	ID_SINGLETONVARS ID of a Sigleton Variables Found Event
static int	ID_SOLUTION ID of a Solution Event
static int	ID_UNDEFPREDICATE ID of a Undefined predicate Event
static int	ID_USERINPUTDONE ID of a WaitForUserInput Event
static int	ID_WAITFORUSERINPUT ID of a WaitForUserInput Event

Method Summary

void	consume() Consumes this JIPEvent object so other JIPEventListeners don't receive it
int	getID() Gets the ID of this JIPEvent object
int	getQueryHandle() Gets the handle of the query related to this JIPEvent object
JIPEngine	getSource() Gets the source of this JIPEvent object
JIPTerm	getTerm() Gets the notified term
long	when() Timestamp of this JIPEvent object

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID_SOLUTION

public static final int ID_SOLUTION

ID of a Solution Event

See Also:

Constant Field Values

ID_OPEN

public static final int ID_OPEN

ID of an Open Event

See Also:

Constant Field Values

ID_CLOSE

public static final int ID_CLOSE

ID of a Close Event

See Also:

Constant Field Values

ID_END

public static final int ID_END

ID of a End Event

See Also:

Constant Field Values

ID_MORE

public static final int ID_MORE

ID of a More Event

See Also:

Constant Field Values

ID_WAITFORUSERINPUT

public static final int ID_WAITFORUSERINPUT

ID of a WaitForUserInput Event

See Also:

Constant Field Values

ID_USERINPUTDONE

public static final int ID_USERINPUTDONE

ID of a WaitForUserInput Event

See Also:

Constant Field Values

ID_UNDEFPREDICATE

public static final int ID_UNDEFPREDICATE

ID of a Undefined predicate Event

See Also:

Constant Field Values

ID_SINGLETONVARS

public static final int ID_SINGLETONVARS

ID of a Sigleton Variables Found Event

See Also:

Constant Field Values

Method Detail

getID

public int getID()

Gets the ID of this JIPEvent object

Returns:

ID of the event

getQueryHandle

public int getQueryHandle()

Gets the handle of the query related to this JIPEvent object

Returns:

handle of the query

when

public long when()

Timestamp of this JIPEvent object

Returns:

timestamp of this JIPEvent object

getSource

public JIPEngine getSource()

Gets the source of this JIPEvent object

Returns:

instance of JIPEngine object sending this JIPEvent object

See Also:

JIPEngine

getTerm

public JIPTerm getTerm()

Gets the notified term

Returns:

term notified by user (notify/2)

See Also:

JIPTerm

consume

public void consume()

Consumes this JIPEvent object so other JIPEventListeners don't receive it