Package org.goplanit.path.choice

Class StochasticPathChoiceBuilder

java.lang.Object

org.goplanit.utils.builder.Builder<T>

org.goplanit.component.PlanitComponentBuilder<T>

org.goplanit.path.choice.PathChoiceBuilder<StochasticPathChoice>

org.goplanit.path.choice.StochasticPathChoiceBuilder

public class StochasticPathChoiceBuilder
extends PathChoiceBuilder<StochasticPathChoice>

All path choice instances are built using this or a derived version of this builder

Author:

markr

Field Summary

Fields

Modifier and Type	Field	Description
protected static Logger	LOGGER	the logger

Fields inherited from class org.goplanit.component.PlanitComponentBuilder

groupId

Constructor Summary

Constructors

Constructor	Description
StochasticPathChoiceBuilder(IdGroupingToken projectToken, InputBuilderListener inputBuilderListener)	Constructor

Method Summary

Modifier and Type	Method	Description
protected void	buildSubComponents(StochasticPathChoice pathChoiceInstance)	call to build and configure all sub components of this builder
protected Configurator<StochasticPathChoice>	createConfigurator()	Allow derived classes to provide their own configurator for this builder, by default we create a base class configurator
protected LogitChoiceModel	createLogitChoiceModelInstance(StochasticPathChoiceConfigurator configurator)	create a logit model instance based on passed in configurator

Methods inherited from class org.goplanit.path.choice.PathChoiceBuilder

build, createPathChoiceInstance

Methods inherited from class org.goplanit.component.PlanitComponentBuilder

getGroupIdToken, getInputBuilderListener

Methods inherited from class org.goplanit.utils.builder.Builder

getClassToBuild, getConfigurator

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final Logger LOGGER

the logger

Constructor Detail

StochasticPathChoiceBuilder

public StochasticPathChoiceBuilder(IdGroupingToken projectToken,
                                   InputBuilderListener inputBuilderListener)
                            throws PlanItException

Constructor

Parameters:

projectToken - idGrouping token

inputBuilderListener - the input builder listener

Throws:

PlanItException - thrown if error

Method Detail

createConfigurator

protected Configurator<StochasticPathChoice> createConfigurator()
                                                         throws PlanItException

Allow derived classes to provide their own configurator for this builder, by default we create a base class configurator

Specified by:

createConfigurator in class Builder<StochasticPathChoice>

Returns:

appropriate configurator

Throws:

PlanItException - thrown if error

createLogitChoiceModelInstance

protected LogitChoiceModel createLogitChoiceModelInstance(StochasticPathChoiceConfigurator configurator)
                                                   throws PlanItException

create a logit model instance based on passed in configurator

Parameters:

configurator - for the path choice

Returns:

created choice model

Throws:

PlanItException - thrown if error

buildSubComponents

protected void buildSubComponents(StochasticPathChoice pathChoiceInstance)
                           throws PlanItException

call to build and configure all sub components of this builder

Specified by:

buildSubComponents in class PathChoiceBuilder<StochasticPathChoice>

Parameters:

pathChoiceInstance - the instance to build on

Throws:

PlanItException - thrown if error