Package org.planit.output.property

Class BaseOutputProperty

java.lang.Object

org.planit.output.property.BaseOutputProperty

All Implemented Interfaces:

Comparable<BaseOutputProperty>

Direct Known Subclasses:

CalculatedSpeedOutputProperty, CapacityPerLaneOutputProperty, CostTimesFlowOutputProperty, DensityOutputProperty, DestinationZoneExternalIdOutputProperty, DestinationZoneIdOutputProperty, DownstreamNodeExternalIdOutputProperty, DownstreamNodeIdOutputProperty, DownstreamNodeLocationOutputProperty, FlowOutputProperty, IterationIndexOutputProperty, LengthOutputProperty, LinkCostOutputProperty, LinkSegmentExternalIdOutputProperty, LinkSegmentIdOutputProperty, LinkTypeOutputProperty, MaximumDensityOutputProperty, MaximumSpeedOutputProperty, ModeExternalIdOutputProperty, ModeIdOutputProperty, NumberOfLanesOutputProperty, ODCostOutputProperty, OriginZoneExternalIdOutputProperty, OriginZoneIdOutputProperty, PathIdOutputProperty, PathOutputStringProperty, RunIdOutputProperty, TimePeriodExternalIdOutputProperty, TimePeriodIdOutputProperty, UpstreamNodeExternalIdOutputProperty, UpstreamNodeIdOutputProperty, UpstreamNodeLocationOutputProperty, VCRatioOutputProperty

public abstract class BaseOutputProperty
extends Object
implements Comparable<BaseOutputProperty>

Template for output property classes which can be included in the output files. All concrete output property classes must be final and extend this class.

Author:

gman6028

Constructor Summary

Constructors

Constructor	Description
BaseOutputProperty()

Method Summary

Modifier and Type	Method	Description
int	compareTo(BaseOutputProperty otherProperty)	compareTo method used to order the output columns when output is being written
static BaseOutputProperty	convertToBaseOutputProperty(String propertyClassName)	Generate the appropriate BaseOutputProperty object from a specified class name
static BaseOutputProperty	convertToBaseOutputProperty(OutputProperty outputProperty)	Generate the appropriate BaseOutputProperty object from a specified enumeration value
boolean	equals(Object otherProperty)	Overridden equals() method This method is needed to allow output properties to be removed from the output list if required.
abstract OutputPropertyPriority	getColumnPriority()	Gets the column priority of the output property in output files The lower the column priority value of a property, the further to the left it is placed in the output file
abstract String	getName()	Returns the name of the output property
abstract OutputProperty	getOutputProperty()	Return the value of the OutputProperty enumeration for this property
abstract Type	getType()	Returns the data type of the output property
abstract Units	getUnits()	Returns the units of the output property
int	hashCode()	Overridden hashCode() method This method is needed to allow output properties to be removed from the output list if required.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BaseOutputProperty

public BaseOutputProperty()

Method Detail

getName

public abstract String getName()

Returns the name of the output property

Returns:

name of the output property

getUnits

public abstract Units getUnits()

Returns the units of the output property

Returns:

units of the output property

getType

public abstract Type getType()

Returns the data type of the output property

Returns:

data type of the output property

getOutputProperty

public abstract OutputProperty getOutputProperty()

Return the value of the OutputProperty enumeration for this property

Returns:

the value of the OutputProperty enumeration for this property

getColumnPriority

public abstract OutputPropertyPriority getColumnPriority()

Gets the column priority of the output property in output files The lower the column priority value of a property, the further to the left it is placed in the output file

Returns:

the column priority

equals

public boolean equals(Object otherProperty)

Overridden equals() method This method is needed to allow output properties to be removed from the output list if required.

Overrides:

equals in class Object

Parameters:

otherProperty - output property to be compared to this one

hashCode

public int hashCode()

Overridden hashCode() method This method is needed to allow output properties to be removed from the output list if required.

Overrides:

hashCode in class Object

compareTo

public int compareTo(BaseOutputProperty otherProperty)

compareTo method used to order the output columns when output is being written

Specified by:

compareTo in interface Comparable<BaseOutputProperty>

Parameters:

otherProperty - output property which is being compared to the current one

convertToBaseOutputProperty

public static BaseOutputProperty convertToBaseOutputProperty(String propertyClassName)
                                                      throws PlanItException

Generate the appropriate BaseOutputProperty object from a specified class name

Parameters:

propertyClassName - the class name of the specified output property

Returns:

the BaseOutputProperty object corresponding to the specified enumeration value

Throws:

PlanItException - thrown if there is an error creating the object

convertToBaseOutputProperty

public static BaseOutputProperty convertToBaseOutputProperty(OutputProperty outputProperty)
                                                      throws PlanItException

Generate the appropriate BaseOutputProperty object from a specified enumeration value

Parameters:

outputProperty - the enumeration value of the specified output property

Returns:

the BaseOutputProperty object corresponding to the specified enumeration value

Throws:

PlanItException - thrown if there is an error creating the object