Package org.goplanit.output.configuration

Class OdOutputTypeConfiguration

java.lang.Object

org.goplanit.output.configuration.OutputTypeConfiguration

org.goplanit.output.configuration.OdOutputTypeConfiguration

public class OdOutputTypeConfiguration
extends OutputTypeConfiguration

The configuration for the origin-destination output type. The following OutputProperty values are included by default:

• TIME_PERIOD_XML_ID
• MODE_XML_ID
• ORIGIN_ZONE_XML_ID
• DESTINATION_ZONE_XML_ID
• OD_COST

Author:

markr

Field Summary

Fields inherited from class org.goplanit.output.configuration.OutputTypeConfiguration

activeSubOutputTypes, outputProperties, outputType

Constructor Summary

Constructors

Constructor	Description
OdOutputTypeConfiguration()	Constructor Define the default output properties here.

Method Summary

Modifier and Type	Method	Description
void	activateOdSkimOutputType(OdSkimSubOutputType odSkimOutputType)	Activate an ODSkimOutputType for this output type configuration
void	deactivateOdSkimOutputType(OdSkimSubOutputType odSkimOutputType)	Deactivate an ODSkimOutputType for this output type configuration
boolean	isOutputPropertyValid(OutputProperty baseOutputProperty)	Checks the output property type being added in valid for the current output type configuration
OutputProperty[]	validateAndFilterKeyProperties(OutputProperty[] outputKeyProperties)	Validate whether the specified list of keys is valid, and if it is return only the keys which will be used

Methods inherited from class org.goplanit.output.configuration.OutputTypeConfiguration

activateSubOutputType, addProperty, deactivateSubOutputType, getActiveSubOutputTypes, getOutputKeyProperties, getOutputProperties, getOutputProperty, getOutputType, getOutputValueProperties, hasActiveSubOutputTypes, overrideOutputPropertyUnits, removeAllProperties, removeProperty, removeProperty

Methods inherited from class java.lang.Object

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

Constructor Detail

OdOutputTypeConfiguration

public OdOutputTypeConfiguration()
                          throws PlanItException

Constructor Define the default output properties here.

Throws:

PlanItException - thrown if there is an error adding the default properties

Method Detail

validateAndFilterKeyProperties

public OutputProperty[] validateAndFilterKeyProperties(OutputProperty[] outputKeyProperties)

Validate whether the specified list of keys is valid, and if it is return only the keys which will be used

Specified by:

validateAndFilterKeyProperties in class OutputTypeConfiguration

Parameters:

outputKeyProperties - array of output key property types

Returns:

array of keys to be used (null if the list is not valid)

activateOdSkimOutputType

public void activateOdSkimOutputType(OdSkimSubOutputType odSkimOutputType)

Activate an ODSkimOutputType for this output type configuration

Parameters:

odSkimOutputType - ODSkimOutputType to be activated

deactivateOdSkimOutputType

public void deactivateOdSkimOutputType(OdSkimSubOutputType odSkimOutputType)

Deactivate an ODSkimOutputType for this output type configuration

Parameters:

odSkimOutputType - ODSkimOutputType to be deactivated

isOutputPropertyValid

public boolean isOutputPropertyValid(OutputProperty baseOutputProperty)

Checks the output property type being added in valid for the current output type configuration

Specified by:

isOutputPropertyValid in class OutputTypeConfiguration

Parameters:

baseOutputProperty - the output property type being added

Returns:

true if the output property is valid, false otherwise