Method Detail

• create

  SpotTracker create(SpotCollection spots,
                     Map<String,Object> settings)

  Instantiates and returns a new SpotTracker configured to operate on the specified SpotCollection, using the specified settins map.

  Parameters:

  spots - the SpotCollection containing the spots to track.

  settings - the settings map configuring the tracker.

  Returns:

  a new SpotTracker instance.

• getTrackerConfigurationPanel

  ConfigurationPanel getTrackerConfigurationPanel(Model model)

  Returns a new GUI panel able to configure the settings suitable for the target tracker identified by the key parameter.

  Parameters:

  model - the model that will be modified by the target tracker.

  Returns:

  a new configuration panel.

• marshall

  boolean marshall(Map<String,Object> settings,
                   org.jdom2.Element element)

  Marshalls a settings map to a JDom element, ready for saving to XML. The element is updated with new attributes.

  Only parameters specific to the concrete tracker factory are marshalled. The element also always receive an attribute named that saves the target SpotTracker key.

  Returns:

  true if marshalling was successful. If not, check getErrorMessage()

• unmarshall

  boolean unmarshall(org.jdom2.Element element,
                     Map<String,Object> settings)

  Un-marshall a JDom element to update a settings map, and sets the target tracker of this provider from the element.

  Concretely: the the specific settings map for the targeted tracker is updated from the element.

  Parameters:

  element - the JDom element to read from.

  settings - the map to update. Is cleared prior to updating, so that it contains only the parameters specific to the target tracker.

  Returns:

  true if unmarshalling was successful. If not, check getErrorMessage()

• toString

  String toString(Map<String,Object> sm)

  A utility method that builds a string representation of a settings map owing to the currently selected tracker in this provider.

  Parameters:

  sm - the map to echo.

  Returns:

  a string representation of the map.

• getDefaultSettings

  Map<String,Object> getDefaultSettings()

  Returns a new default settings map suitable for the tracker Settings are instantiated with default values. is returned.

  Returns:

  a settings map.

• checkSettingsValidity

  boolean checkSettingsValidity(Map<String,Object> settings)

  Checks the validity of the given settings map for the tracker. The validity check is strict: we check that all needed parameters are here and are of the right class, and that there is no extra unwanted parameters.

  Returns:

  true if the settings map can be used with the target factory. If not, check getErrorMessage()

• getErrorMessage

  String getErrorMessage()

  Returns a meaningful error message for the last action on this factory.

  Returns:

  an error message.

  See Also:

  marshall(Map, Element), unmarshall(Element, Map), checkSettingsValidity(Map)