Package org.web3d.vrml.scripting.external.neteai

Interface FieldAndNodeRequestProcessor

All Known Implementing Classes:

ClientProcessingTask

public interface FieldAndNodeRequestProcessor

FieldAndNodeRequestProcessor is the interface abstracting the class which handles all of the EAI field and node requests. The callers are expected to supply the appropriate network IDs in place of the implicit node and field objects.

Method Summary

Modifier and Type	Method	Description
void	addVrmlEventListener(int fieldID, int fieldType, VrmlEventListener l)	Add a listener to event changes for a field.
void	disposeNode(int nodeID)	Notify server that node is no longer referenced.
EventIn	getEventIn(int nodeID, String fieldName)	Get an eventIn for a given field name on a given node
EventOut	getEventOut(int nodeID, String fieldName)	Get an eventOut for a given field name on a given node
void	getFieldValue(int fieldID, org.web3d.vrml.scripting.external.neteai.EventWrapper buffer)	Transmit a getFieldValue request.
int	getImageComponents(int fieldID)	Return the number of components in an SFImage field
int	getImageHeight(int fieldID)	Return the height on an SFImage field
int	getImageWidth(int fieldID)	Return the width of an SFImage field
int	getNode(String nodeName)	Transmit a getNode request to the server and wait for reply.
String	getNodeType(int nodeID)	Returns the type name for a given node.
int	getNumFieldValues(int fieldID)	Get the number of elements in this field's value
Object	getUserData(int fieldID)	Get the user data associated with a field.
void	removeVrmlEventListener(int fieldID, VrmlEventListener l)	Remove a listener from the listeners for a field.
void	setFieldValue(int fieldID, org.web3d.vrml.scripting.external.neteai.EventWrapper buffer)	Transmit a setFieldValue request.
void	setUserData(int fieldID, Object data)	Set the user data associated with a field.

Method Details

disposeNode

void disposeNode(int nodeID)

Notify server that node is no longer referenced. Does not check for remaining instances.

Parameters:

nodeID - Network ID of the node to dispose

getEventIn

EventIn getEventIn(int nodeID,
 String fieldName)

Get an eventIn for a given field name on a given node

Parameters:

nodeID - The network ID of the node

fieldName - The name of the field

Returns:

The eventIn object

getEventOut

EventOut getEventOut(int nodeID,
 String fieldName)

Get an eventOut for a given field name on a given node

Parameters:

nodeID - The network ID of the node

fieldName - The name of the field

Returns:

The eventOut object

getNode

int getNode(String nodeName)

Transmit a getNode request to the server and wait for reply.

Parameters:

nodeName - The nodeName to request

Returns:

The ID for the node if found.

getNodeType

String getNodeType(int nodeID)

Returns the type name for a given node.

Parameters:

nodeID - The network ID of the node.

Returns:

The type name of the node.

setFieldValue

void setFieldValue(int fieldID,
 org.web3d.vrml.scripting.external.neteai.EventWrapper buffer)

Transmit a setFieldValue request. The buffer holds the field value to transmit using writeFieldValue.

Parameters:

fieldID - The network field ID

buffer - The buffer holding the value

getFieldValue

void getFieldValue(int fieldID,
 org.web3d.vrml.scripting.external.neteai.EventWrapper buffer)

Transmit a getFieldValue request. The buffer will receive the field value using readFieldValue.

Parameters:

fieldID - The network field ID

buffer - The buffer to receive the value

getUserData

Object getUserData(int fieldID)

Get the user data associated with a field. This is implemented on the client side.

Parameters:

fieldID - The network field ID

Returns:

The user data object

setUserData

void setUserData(int fieldID,
 Object data)

Set the user data associated with a field. This is implemented on the client side.

Parameters:

fieldID - The network field ID

data - The user data object

removeVrmlEventListener

void removeVrmlEventListener(int fieldID,
 VrmlEventListener l)

Remove a listener from the listeners for a field. Will turn off event notifications if this is the last listener for that field.

Parameters:

fieldID - The network ID of the field.

l - The listener to remove

addVrmlEventListener

void addVrmlEventListener(int fieldID,
 int fieldType,
 VrmlEventListener l)

Add a listener to event changes for a field. Turns on event notifications as needed. Need to pass the field type so that the broadcast system knows what to generate when updates arrive.

Parameters:

fieldID - The network ID of the field

fieldType - The type of the field

l - The listener to add.

getNumFieldValues

int getNumFieldValues(int fieldID)

Get the number of elements in this field's value

Parameters:

fieldID - The network ID of this field

Returns:

The number of elements in the field's value

getImageComponents

int getImageComponents(int fieldID)

Return the number of components in an SFImage field

Parameters:

fieldID - The network field ID

Returns:

The number of components in the image

getImageHeight

int getImageHeight(int fieldID)

Return the height on an SFImage field

Parameters:

fieldID - The network field ID

Returns:

The height of the image

getImageWidth

int getImageWidth(int fieldID)

Return the width of an SFImage field

Parameters:

fieldID - The network field ID

Returns:

The width of the image