Package org.opensourcephysics.media.core

Class DataTrackSupport

java.lang.Object

org.opensourcephysics.media.core.DataTrackSupport

public class DataTrackSupport
extends java.lang.Object

A class to support the RMI transfer of data to the Tracker DataTrackTool.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	HOST
static int	PORT

Method Summary

Modifier and Type	Method	Description
static boolean	connect(int id, java.beans.PropertyChangeListener listener)	Connects to Tracker and adds a PropertyChangeListener to listen for Tracker messages and requests.
static XMLControl	getMessageControl(int id)	Clears and returns the message XMLControl.
static boolean	isDataRequested()	Determines if data was requested by Tracker when the current process was started.
static boolean	isTrackerAvailable()	Determines if a DataTrack-enabled Tracker is available on this machine.
static boolean	sendAppendedData(int id, Data data)	Sends previously sent Data with newly appended values.
static boolean	sendData(int id, Data data)	Sends data to the remote DataTrackTool.
static boolean	sendMessage(int id, java.util.Map<java.lang.String,java.lang.Object> message)	Sends a message to the remote DataTrackTool in the form of a String-to-Object mapping.

Methods inherited from class java.lang.Object

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

Field Detail

HOST

public static final java.lang.String HOST

See Also:

Constant Field Values

PORT

public static final int PORT

See Also:

Constant Field Values

Method Detail

connect

public static boolean connect(int id,
                              java.beans.PropertyChangeListener listener)

Connects to Tracker and adds a PropertyChangeListener to listen for Tracker messages and requests. This returns false if Tracker is unavailable. The PropertyChangeListener is notified with a "tracker_ready" PropertyChangeEvent when Tracker is ready to receive data.

Parameters:

id - a number to identify the data source (typically hashcode())

listener - the PropertyChangeListener to notify when the remote tool is ready

Returns:

true if Tracker is available

sendData

public static boolean sendData(int id,
                               Data data)

Sends data to the remote DataTrackTool. Data must include (x, y) positions.

Parameters:

id - a number to identify the data source (typically hashcode())

data - the Data object to send

Returns:

true if the data was sent successfully

sendAppendedData

public static boolean sendAppendedData(int id,
                                       Data data)

Sends previously sent Data with newly appended values. Note: DataTrackTool reads only the appended values. If previously sent values have changed, use the sendData method instead. Note: Data should contain previously sent data plus appended data, not appended data only.

Parameters:

id - a number to identify the data source (typically hashcode())

data - the Data with appended values

Returns:

true if the data was sent successfully

sendMessage

public static boolean sendMessage(int id,
                                  java.util.Map<java.lang.String,java.lang.Object> message)

Sends a message to the remote DataTrackTool in the form of a String-to-Object mapping. The message may include Data as a "data"-to-Data mapping.

Parameters:

id - a number to identify the data source (typically hashcode())

message - the message to send

Returns:

true if sent successfully

isTrackerAvailable

public static boolean isTrackerAvailable()

Determines if a DataTrack-enabled Tracker is available on this machine. This returns true if a tracker.jar file is found in the OSP preference TRACKER_HOME. Requires Tracker version 5.00 (build-date 2015) or above.

Returns:

true if Tracker is available (whether or not it is running)

isDataRequested

public static boolean isDataRequested()

Determines if data was requested by Tracker when the current process was started. EJS models should check this when first launched and send data if true.

Returns:

true if data was requested

getMessageControl

public static XMLControl getMessageControl(int id)

Clears and returns the message XMLControl.

Returns:

the XMLCntrol