uk.ac.vamsas.client.picking
Class SelectionMessage

java.lang.Object
  extended byuk.ac.vamsas.client.picking.Message
      extended byuk.ac.vamsas.client.picking.SelectionMessage

public class SelectionMessage
extends Message

Send and receive details about vamsas object selections and selection ranges defined on one or more objects.

Author:
J.B. Procter

Field Summary
 
Fields inherited from class uk.ac.vamsas.client.picking.Message
message
 
Constructor Summary
SelectionMessage(java.lang.String str)
          parse a message payload as a selection message
SelectionMessage(java.lang.String selectionID, java.lang.String[] vorbaIDs, RangeType ranges)
          create a new selection message
SelectionMessage(java.lang.String selectionID, java.lang.String[] vorbaIDs, RangeType ranges, boolean none)
           
 
Method Summary
 RangeType getRanges()
           
 java.lang.String getSelectionID()
           
 java.lang.String[] getVorbaIDs()
           
 boolean isNone()
           
 
Methods inherited from class uk.ac.vamsas.client.picking.Message
equals, getRawMessage, validate
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SelectionMessage

public SelectionMessage(java.lang.String str)
parse a message payload as a selection message

Parameters:
str -

SelectionMessage

public SelectionMessage(java.lang.String selectionID,
                        java.lang.String[] vorbaIDs,
                        RangeType ranges)
create a new selection message

Parameters:
selectionID - - (may be null) optional handle (or ID) to refer to selection by
vorbaIDs - - one or more objects to be selected, or null for the empty selection
ranges - optional rangetype specifying positions or intervals over object(s) coordinate system.

SelectionMessage

public SelectionMessage(java.lang.String selectionID,
                        java.lang.String[] vorbaIDs,
                        RangeType ranges,
                        boolean none)
Method Detail

getSelectionID

public java.lang.String getSelectionID()
Returns:
the selectionID

getVorbaIDs

public java.lang.String[] getVorbaIDs()
Returns:
the vorbaIDs

getRanges

public RangeType getRanges()
Returns:
the ranges

isNone

public boolean isNone()
Returns:
the none