TreeLogger

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<java.beans.PropertyChangeListener>`	`listeners`
`protected repicea.simulation.treelogger.TreeLoggerTask<?>`	`loggerTask`
`protected java.awt.Window`	`owner`
`protected Parameter`	`params`
`protected boolean`	`progressBarEnabled`
`protected TreeLoggerWrapper`	`wrapper` Deprecated.

Constructor Summary

Constructors
Modifier Constructor and Description

protected TreeLogger()
General construtor for all AbstractTreeLogger-derived classes.

Constructors
Modifier	Constructor and Description
`protected`	`TreeLogger()` General construtor for all AbstractTreeLogger-derived classes.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTreeLoggerListener(java.beans.PropertyChangeListener listener)` This method adds the listener instance if it is not already contained in the listeners list.
`protected void`	`addWoodPiece(Tree tree, WoodPiece pieceToAdd)` This method adds a WoodPiece instance in the set of WoodPiece associated to the LoggableTree tree.
`void`	`cancel()` This method is called to cancel a running task.
`abstract Parameter`	`createDefaultTreeLoggerParameters()` This method returns a set of default parameters to make sure the logger can work.
`abstract Tree`	`getEligible(LoggableTree t)` This method determines whether or not the tree is eligible for this tree logger.
`protected java.util.Collection<Tree>`	`getEligibleTreesFromACollection(java.util.Collection<?> trees)` This method extracts a collection of TreePetroLoggable objects from a collection of LoggableTree instances.
`java.lang.Exception`	`getFailureReason()` This method returns the exception that has caused the task to terminate incorrectly.
`java.util.Collection<Tree>`	`getLoggableTrees()` This method returns the collection of LoggableTree instances that the logger has to work on.
`java.lang.String`	`getName()` This method returns the name of the task.
`Parameter`	`getTreeLoggerParameters()` This method returns the parameters of the TreeLogger object.
`java.util.Map<LoggableTree,java.util.Collection<WoodPiece>>`	`getWoodPieces()` This method returns the SetMap object that contains the trees in keys and their associated wood pieces once they are processed.
`boolean`	`hasBeenCancelled()` This method returns true if the method cancel() has been called.
`void`	`init(java.util.Collection<?> newtrees)` This method initializes the TreeLogger instance by setting the collection of LoggableTree objects on which the logger has to work.
`abstract boolean`	`isCompatibleWith(TreeLoggerCompatibilityCheck check)` This method makes it possible to determine whether or not this TreeLogger class is compatible with the reference object
`boolean`	`isCorrectlyTerminated()` This method returns true if the task is correctly terminated or false otherwise.
`protected boolean`	`isSaveMemoryEnabled()` This method checks if the logger is operating in safe memory mode.
`boolean`	`isVerbose()` This method returns true if the task displays messages.
`protected abstract void`	`logThisTree(Tree tree)` This method process the trees into logs.
`protected void`	`logTrees()` This method instantiate a TreeLoggerTask and run this task.
`protected void`	`posteriorToRunning()` This method is run just after launching the logger task.
`protected void`	`priorToRunning()` This method is run just before launching the logger task.
`void`	`removeTreeLoggerListener(java.beans.PropertyChangeListener listener)` This method removes the instance listener from the listeners.
`void`	`run()`
`void`	`setProgressBarEnabled(boolean bool, java.awt.Window owner)` This method enables a progress bar related to window owner.
`void`	`setSaveMemoryEnabled(boolean saveMemory)` This method enables the save memory mode.
`abstract void`	`setTreeLoggerParameters()` This method is called in GUI mode.
`void`	`setTreeLoggerParameters(Parameter params)` This method sets the parameters in script mode.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - wrapper
```
@Deprecated
protected TreeLoggerWrapper wrapper
```
    Deprecated.
  - params
```
protected Parameter extends TreeLoggerParameters<? extends LogCategory> params
```
  - loggerTask
```
protected repicea.simulation.treelogger.TreeLoggerTask<?> loggerTask
```
  - listeners
```
protected java.util.List<java.beans.PropertyChangeListener> listeners
```
  - owner
```
protected java.awt.Window owner
```
  - progressBarEnabled
```
protected boolean progressBarEnabled
```
- Constructor Detail
  - TreeLogger
```
protected TreeLogger()
```
    General construtor for all AbstractTreeLogger-derived classes.
- Method Detail
  - addTreeLoggerListener
```
public void addTreeLoggerListener(java.beans.PropertyChangeListener listener)
```
    This method adds the listener instance if it is not already contained in the listeners list.
    
    Parameters:
    
    listener - a PropertyChangeListener
  - removeTreeLoggerListener
```
public void removeTreeLoggerListener(java.beans.PropertyChangeListener listener)
```
    This method removes the instance listener from the listeners.
    
    Parameters:
    
    listener - a PropertyChangeListener instance
  - init
```
public void init(java.util.Collection<?> newtrees)
```
    This method initializes the TreeLogger instance by setting the collection of LoggableTree objects on which the logger has to work. If the number of LoggableTree objects exceeds the value of TreeLogger.NB_TREES_BEFORE_MEMORY_OVERFLOW, the logger adopts a safe memory strategy, i.e., it calls the method setSaveMemoryEnabled(true).
    
    Parameters:
    
    newtrees - a Collection of LoggableTree objects to be processed
    
    Throws:
    
    java.security.InvalidParameterException - if the collection trees is null or empty
  - getLoggableTrees
```
public java.util.Collection<Tree> getLoggableTrees()
```
    This method returns the collection of LoggableTree instances that the logger has to work on.
    
    Returns:
    
    a Collection of LoggableTree-derived instances
  - setProgressBarEnabled
```
public void setProgressBarEnabled(boolean bool,
                                  java.awt.Window owner)
```
    This method enables a progress bar related to window owner.
    
    Parameters:
    
    bool - true to enable the progress bar or false otherwise (which is the default value)
    
    owner - a Window instance (can be null)
  - addWoodPiece
```
protected void addWoodPiece(Tree tree,
                            WoodPiece pieceToAdd)
```
    This method adds a WoodPiece instance in the set of WoodPiece associated to the LoggableTree tree.
    
    Parameters:
    
    tree - a LoggableTree
    
    pieceToAdd - a WoodPiece to add
  - logThisTree
```
protected abstract void logThisTree(Tree tree)
```
    This method process the trees into logs. It has to be defined in the derived class.
  - run
```
public final void run()
```
    Specified by:
    
    run in interface java.lang.Runnable
  - logTrees
```
protected void logTrees()
```
    This method instantiate a TreeLoggerTask and run this task. Instructions prior to this can be implemented in the priorToRunning() method while instructions after the completion of this task can be implemented in the posteriorToRunning() method.
  - priorToRunning
```
protected void priorToRunning()
```
    This method is run just before launching the logger task.
  - posteriorToRunning
```
protected void posteriorToRunning()
```
    This method is run just after launching the logger task.
  - getWoodPieces
```
public java.util.Map<LoggableTree,java.util.Collection<WoodPiece>> getWoodPieces()
```
    This method returns the SetMap object that contains the trees in keys and their associated wood pieces once they are processed.
    
    Returns:
    
    a Map> instance
  - getTreeLoggerParameters
```
public Parameter getTreeLoggerParameters()
```
    This method returns the parameters of the TreeLogger object.
    
    Returns:
    
    a Parameter-defined instance (see header of this class)
  - setSaveMemoryEnabled
```
public void setSaveMemoryEnabled(boolean saveMemory)
```
    This method enables the save memory mode. Might have no effect if the tree logger does not implement any different method. By default this mode is enabled.
    
    Parameters:
    
    saveMemory - true to enable this mode
  - isSaveMemoryEnabled
```
protected boolean isSaveMemoryEnabled()
```
    This method checks if the logger is operating in safe memory mode.
    
    Returns:
    
    a boolean
  - setTreeLoggerParameters
```
public void setTreeLoggerParameters(Parameter params)
```
    This method sets the parameters in script mode.
    
    Parameters:
    
    params - a TreeLoggerParameters instance
  - setTreeLoggerParameters
```
public abstract void setTreeLoggerParameters()
```
    This method is called in GUI mode.
  - createDefaultTreeLoggerParameters
```
public abstract Parameter createDefaultTreeLoggerParameters()
```
    This method returns a set of default parameters to make sure the logger can work.
    
    Returns:
    
    a set of Parameters-derived instance
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: GenericTask
    
    This method returns the name of the task.
    
    Specified by:
    
    getName in interface GenericTask
    
    Returns:
    
    a String object
  - cancel
```
public void cancel()
```
    Description copied from interface: GenericTask
    
    This method is called to cancel a running task.
    
    Specified by:
    
    cancel in interface GenericTask
  - hasBeenCancelled
```
public boolean hasBeenCancelled()
```
    Description copied from interface: GenericTask
    
    This method returns true if the method cancel() has been called.
    
    Specified by:
    
    hasBeenCancelled in interface GenericTask
    
    Returns:
    
    a boolean
  - isCorrectlyTerminated
```
public boolean isCorrectlyTerminated()
```
    Description copied from interface: Executable
    
    This method returns true if the task is correctly terminated or false otherwise.
    
    Specified by:
    
    isCorrectlyTerminated in interface Executable
    
    Returns:
    
    a Boolean instance
  - getEligibleTreesFromACollection
```
protected java.util.Collection<Tree> getEligibleTreesFromACollection(java.util.Collection<?> trees)
```
    This method extracts a collection of TreePetroLoggable objects from a collection of LoggableTree instances.
    
    Parameters:
    
    trees - a Collection of LoggableTree-derived instances
    
    Returns:
    
    a Collection of PetroLoggableTree instances
  - getFailureReason
```
public java.lang.Exception getFailureReason()
```
    Description copied from interface: Executable
    
    This method returns the exception that has caused the task to terminate incorrectly.
    
    Specified by:
    
    getFailureReason in interface Executable
    
    Returns:
    
    an Exception
  - getEligible
```
public abstract Tree getEligible(LoggableTree t)
```
    This method determines whether or not the tree is eligible for this tree logger. Typically, some criteria based on dbh or height can be specified here.
    
    Parameters:
    
    t - a LoggableTree instance
    
    Returns:
    
    the appropriate Tree instance if eligible or null otherwise
  - isCompatibleWith
```
public abstract boolean isCompatibleWith(TreeLoggerCompatibilityCheck check)
```
    This method makes it possible to determine whether or not this TreeLogger class is compatible with the reference object
    
    Parameters:
    
    check - a TreeLoggerCompatibilityCheck instance
    
    Returns:
    
    a boolean
  - isVerbose
```
public boolean isVerbose()
```
    Description copied from interface: GenericTask
    
    This method returns true if the task displays messages.
    
    Specified by:
    
    isVerbose in interface GenericTask
    
    Returns:
    
    a boolean

Class TreeLogger<Parameter extends TreeLoggerParameters<? extends LogCategory>,Tree extends LoggableTree>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

wrapper

params

loggerTask

listeners

owner

progressBarEnabled

Constructor Detail

TreeLogger

Method Detail

addTreeLoggerListener

removeTreeLoggerListener

init

getLoggableTrees

setProgressBarEnabled

addWoodPiece

logThisTree

run

logTrees

priorToRunning

posteriorToRunning

getWoodPieces

getTreeLoggerParameters

setSaveMemoryEnabled

isSaveMemoryEnabled

setTreeLoggerParameters

setTreeLoggerParameters

createDefaultTreeLoggerParameters

getName

cancel

hasBeenCancelled

isCorrectlyTerminated

getEligibleTreesFromACollection

getFailureReason

getEligible

isCompatibleWith

isVerbose