Package org.goplanit.output.configuration

Class PathOutputTypeConfiguration

java.lang.Object

org.goplanit.output.configuration.OutputTypeConfiguration

org.goplanit.output.configuration.PathOutputTypeConfiguration

public class PathOutputTypeConfiguration
extends OutputTypeConfiguration

The configuration for the OD path output type. The following OutputProperty values are included by default:

• PATH_ID
• TIME_PERIOD_XML_ID
• MODE_XML_ID
• ORIGIN_ZONE_XML_ID
• DESTINATION_ZONE_XML_ID
• PATH_STRING

Author:

markr

Field Summary

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

activeSubOutputTypes, outputProperties, outputType

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
PathOutputIdentificationType	getPathIdentificationType()	Get the path id type
boolean	isOutputPropertyValid(OutputProperty baseOutputProperty)	Checks the output property type being added in valid for the current output type configuration
void	setPathIdentificationType(PathOutputIdentificationType pathIdType)	Set the path id type
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

PathOutputTypeConfiguration

public PathOutputTypeConfiguration()
                            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)

setPathIdentificationType

public void setPathIdentificationType(PathOutputIdentificationType pathIdType)
                               throws PlanItException

Set the path id type

Parameters:

pathIdType - the path output type

Throws:

PlanItException - thrown if there is an error

getPathIdentificationType

public PathOutputIdentificationType getPathIdentificationType()

Get the path id type

Returns:

the path id type

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