edu.ucsb.nceas.morpho.datapackage
Class ReferenceSelectionEvent

java.lang.Object
  extended byedu.ucsb.nceas.morpho.datapackage.ReferenceSelectionEvent

public class ReferenceSelectionEvent
extends java.lang.Object

Used when ReferencesHandler class has detected a selection event in the list of available IDs and has obtained the relevant referenced data, either from the current datapackage, or from a remote package. The local/ remote information, along with the full OrderedMap of xpath/value pairs, is encapsulated in an instance of this ReferenceSelectionEvent class and returned to the registered ReferencesListeners


Field Summary
static short CURRENT_DATA_PACKAGE
           
static short DIFFERENT_DATA_PACKAGE
           
static short UNDEFINED
           
 
Constructor Summary
ReferenceSelectionEvent()
           
ReferenceSelectionEvent(java.lang.String refID, short location, OrderedMap referencedData, java.lang.String subtreeRootNodeName)
           
 
Method Summary
 short getLocation()
          get location of original metadata to be referenced
 java.lang.String getReferenceID()
          get referenced id string
 java.lang.String getSubtreeRootNodeName()
          get referenced id string
 OrderedMap getXPathValsMap()
          Get OrderedMap of xpath/value pairs
 void setLocation(short location)
          Set location of original metadata to be referenced
 void setReferenceID(java.lang.String refID)
          Set referenced id string
 void setSubtreeRootNodeName(java.lang.String subtreeRootNodeName)
          Set referenced id string
 void setXPathValsMap(OrderedMap referencedData)
          Set OrderedMap of xpath/value pairs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

UNDEFINED

public static final short UNDEFINED
See Also:
Constant Field Values

CURRENT_DATA_PACKAGE

public static final short CURRENT_DATA_PACKAGE
See Also:
Constant Field Values

DIFFERENT_DATA_PACKAGE

public static final short DIFFERENT_DATA_PACKAGE
See Also:
Constant Field Values
Constructor Detail

ReferenceSelectionEvent

public ReferenceSelectionEvent()

ReferenceSelectionEvent

public ReferenceSelectionEvent(java.lang.String refID,
                               short location,
                               OrderedMap referencedData,
                               java.lang.String subtreeRootNodeName)
Method Detail

setReferenceID

public void setReferenceID(java.lang.String refID)
Set referenced id string

Parameters:
refID - String

getReferenceID

public java.lang.String getReferenceID()
get referenced id string

Returns:
refID String

setSubtreeRootNodeName

public void setSubtreeRootNodeName(java.lang.String subtreeRootNodeName)
Set referenced id string


getSubtreeRootNodeName

public java.lang.String getSubtreeRootNodeName()
get referenced id string

Returns:
refID String

setLocation

public void setLocation(short location)
Set location of original metadata to be referenced

Parameters:
location - short value - ReferenceSelectionEvent.CURRENT_DATA_PACKAGE or ReferenceSelectionEvent.DIFFERENT_DATA_PACKAGE

getLocation

public short getLocation()
get location of original metadata to be referenced

Returns:
location short value - ReferenceSelectionEvent.CURRENT_DATA_PACKAGE or ReferenceSelectionEvent.DIFFERENT_DATA_PACKAGE

setXPathValsMap

public void setXPathValsMap(OrderedMap referencedData)
Set OrderedMap of xpath/value pairs

Parameters:
referencedData - OrderedMap

getXPathValsMap

public OrderedMap getXPathValsMap()
Get OrderedMap of xpath/value pairs

Returns:
OrderedMap


Copyright © 2000 National Center for Ecological Analysis and Synthesis. All Rights Reserved.