repicea.simulation.treelogger

Class LogCategory

java.lang.Object

repicea.simulation.treelogger.LogCategory

All Implemented Interfaces:

java.io.Serializable, REpiceaUIObject

Direct Known Subclasses:

BasicLogCategory, DiameterBasedTreeLogCategory

public abstract class LogCategory
extends java.lang.Object
implements java.io.Serializable, REpiceaUIObject

This abstract class ensures that any TreeLogCategory-derived object has at least (1) a name, (2) a list of end use products and (3) a method that returns the yield of the piece.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
LogCategory() Default instantiation.
LogCategory(java.lang.String name, boolean isFromStump) General constructor for all the TreeLogCategory-derived classes.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
protected abstract java.util.List<? extends WoodPiece>	extractFromTree(LoggableTree tree, java.lang.Object... parms) This method returns a wood piece if it can be extract from the tree.
java.lang.String	getName() This method returns the name of this tree log category.
java.lang.Object	getSpecies()
abstract double	getYieldFromThisPiece(WoodPiece piece) This method returns the yield of this piece, i.e.
boolean	isFromStump() This method returns true if the log category is actually extracted from stumps.
void	setName(java.lang.String str) This method sets the name of this tree log category.
protected void	setSpecies(java.lang.Object species)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface repicea.gui.REpiceaUIObject

getUI, isVisible

Constructor Detail

LogCategory

public LogCategory(java.lang.String name,
                   boolean isFromStump)

General constructor for all the TreeLogCategory-derived classes.

Parameters:

name - the name of the log category

isFromStump - true if this log category is extracted from the stump and the roots

LogCategory

public LogCategory()

Default instantiation.

Method Detail

setSpecies

protected void setSpecies(java.lang.Object species)

getName

public java.lang.String getName()

This method returns the name of this tree log category.

Returns:

a String

setName

public void setName(java.lang.String str)

This method sets the name of this tree log category.

getSpecies

public java.lang.Object getSpecies()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getYieldFromThisPiece

public abstract double getYieldFromThisPiece(WoodPiece piece)
                                      throws java.lang.Exception

This method returns the yield of this piece, i.e. the volume of end use products with respect to the initial volume of this piece.

Parameters:

piece - a WoodPiece instance

Returns:

a Double

Throws:

java.lang.Exception

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

isFromStump

public boolean isFromStump()

This method returns true if the log category is actually extracted from stumps. Typically, this is done with maritime pine, where stumps are converted into energy wood.

Returns:

a boolean

extractFromTree

protected abstract java.util.List<? extends WoodPiece> extractFromTree(LoggableTree tree,
                                                                       java.lang.Object... parms)

This method returns a wood piece if it can be extract from the tree.

Parameters:

tree - a LoggableTree instance

parms - optional parameters

Returns:

a WoodPiece instance or null if cannot be extracted from the tree