Inheritance diagram for tutorial.programming.reflectiveConfigGroup.MyConfigGroup:

Public Member Functions
	MyConfigGroup ()

final void	addParam (final String param_name, final String value)

final String	getValue (final String param_name)

final Map< String, String >	getParams ()

Map< String, String >	getComments ()

final String	getName ()

final String	toString ()

ConfigGroup	createParameterSet (final String type)

void	addParameterSet (final ConfigGroup set)

boolean	removeParameterSet (final ConfigGroup set)

final Collection<?extends ConfigGroup >	getParameterSets (final String type)

final Map< String,?extends Collection<?extends ConfigGroup > >	getParameterSets ()

final boolean	isLocked ()

void	setLocked ()

final void	testForLocked ()

Static Public Member Functions
static URL	getInputFileURL (URL context, String filename)

Static Public Attributes
static final String	GROUP_NAME = "testModule"

Protected Member Functions
void	addParameterToMap (final Map< String, String > map, final String paramName)

void	checkConsistency ()

void	checkParameterSet (final ConfigGroup set)

final Collection<?extends ConfigGroup >	clearParameterSetsForType (final String type)

Private Attributes
double	doubleField = Double.NaN

Id< Link >	idField = null

Coord	coordField = null

MyEnum	enumField = null

String	nonNull = "some arbitrary default value."

Detailed Description

Demonstrate how to use ReflectiveModule to easily create typed config groups. Please do not modify this class: it is used from unit tests!

Definition at line 32 of file MyConfigGroup.java.

Constructor & Destructor Documentation

tutorial.programming.reflectiveConfigGroup.MyConfigGroup.MyConfigGroup ( )

Definition at line 49 of file MyConfigGroup.java.

                            {
         super( GROUP_NAME );
     }

Member Function Documentation

final void org.matsim.core.config.ReflectiveConfigGroup.addParam	(	final String	param_name,
		final String	value
	)

inherited

Definition at line 215 of file ReflectiveConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getName(), and org.matsim.core.config.ReflectiveConfigGroup.invokeSetter().

Referenced by org.matsim.core.config.groups.PlanCalcScoreConfigGroup.addParam(), and org.matsim.core.config.groups.StrategyConfigGroup.addParam().

                                 {
         final Method setter = setters.get( param_name );
 
         if (setter == null) {
             if ( !storeUnknownParameters ) {
                 throw new IllegalArgumentException(
                         "Module "+getName()+" of type "+getClass().getName()+
                         " doesn't accept unkown parameters. Parameter "+param_name+
                         " is not part of the valid parameters: "+setters.keySet() );
             }
             log.warn( "unknown parameter "+param_name+" for group "+getName()+". Here are the valid parameter names: "+setters.keySet() );
             log.warn( "Only the string value will be remembered" );
             super.addParam( param_name , value );
             return;
         }
 
         try {
             invokeSetter( setter , value );
             log.trace( "value "+value+" successfully set for field "+param_name+" for group "+getName() );
         }
         catch (InvocationTargetException e) {
             // this exception wraps Throwables intercepted in the invocation of the setter.
             // Avoid multiple wrappings (exception wrapped in InvocationTargetException
             // itself wrapped in a RuntimeException), as it makes error messages
             // messy.
             final Throwable cause = e.getCause();
             if ( cause instanceof RuntimeException ) {
                 throw (RuntimeException) cause;
             }
 
             if ( cause instanceof Error ) {
                 throw (Error) cause;
             }
 
             throw new RuntimeException( cause );
         }
         catch (IllegalAccessException e) {
             throw new RuntimeException( e );
         }
     }

Here is the call graph for this function:

final String org.matsim.core.config.ReflectiveConfigGroup.getValue ( final String param_name )

inherited

Definition at line 339 of file ReflectiveConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getName().

Referenced by org.matsim.core.scoring.functions.CharyparNagelScoringParameters.Builder.Builder(), and org.matsim.core.config.groups.StrategyConfigGroup.getValue().

                                                           {
         final Method getter = stringGetters.get( param_name );
 
         try {
             if (getter != null) {
                 // do not care about access modifier:
                 // if a method is tagged with the StringGetter
                 // annotation, we are supposed to access it.
                 // This *is* safe.
                 final boolean accessible = getter.isAccessible();
                 getter.setAccessible( true );
                 final Object result = getter.invoke( this );
                 getter.setAccessible( accessible );
 
                 if ( result == null ) {
                     if ( getter.isAnnotationPresent( DoNotConvertNull.class ) ) {
                         log.error( "getter for parameter "+param_name+" of module "+getName()+" returned null." );
                         log.error( "This is not allowed for this getter." );
 
                         throw new NullPointerException( "getter for parameter "+param_name+" of module "+getClass().getName()+" ("+getName()+") returned null." );
                     }
                     return null;
                 }
 
                 final String value = ""+result;
 
                 if ( value.equals( "null" ) && !getter.isAnnotationPresent( DoNotConvertNull.class ) ) {
                     throw new RuntimeException( "parameter "+param_name+" understands null pointers for IO. As a consequence, the \"null\" String is not a valid value for "+getter.getName() );
                 }
 
                 return value;
             }
         }
         catch (InvocationTargetException e) {
             // this exception wraps Throwables intercepted in the invocation of the getter.
             // Avoid multiple wrappings (exception wrapped in InvocationTargetException
             // itself wrapped in a RuntimeException), as it makes error messages
             // messy.
             final Throwable cause = e.getCause();
             if ( cause instanceof RuntimeException ) {
                 throw (RuntimeException) cause;
             }
 
             if ( cause instanceof Error ) {
                 throw (Error) cause;
             }
 
             throw new RuntimeException( cause );
         }
         catch (IllegalAccessException e) {
             throw new RuntimeException( e );
         }
 
         if ( !storeUnknownParameters ) {
             throw new IllegalArgumentException(
                     "Module "+getName()+" of type "+getClass().getName()+
                     " doesn't store unkown parameters. Parameter "+param_name+
                     " is not part of the valid parameters: "+stringGetters.keySet() );
         }
 
         log.warn( "no getter found for param "+param_name+": trying parent method" );
         return super.getValue( param_name );
     }

Here is the call graph for this function:

final Map<String, String> org.matsim.core.config.ReflectiveConfigGroup.getParams ( )

inherited

Definition at line 404 of file ReflectiveConfigGroup.java.

References org.matsim.core.config.ConfigGroup.addParameterToMap().

Referenced by org.matsim.core.config.groups.PlanCalcScoreConfigGroup.getParams(), and org.matsim.core.config.groups.StrategyConfigGroup.getParams().

                                                  {
         final Map<String, String> map = super.getParams();
 
         for (String f : setters.keySet()) {
             addParameterToMap( map , f );
         }
 
         return map;
     }

Here is the call graph for this function:

Map<String, String> org.matsim.core.config.ReflectiveConfigGroup.getComments ( )

inherited

Comments for parameters which setter get an enum type are automatically generated, containing a list of possible values. They can be overriden by subclasses without problems.

it is recommended for subclasses to get this map using super.getComments() and fill it with additional comments, rather than generate an empty map.

Definition at line 424 of file ReflectiveConfigGroup.java.

References org.matsim.core.config.ConfigGroup.params, and org.matsim.core.config.ConfigGroup.toString().

                                              {
         // generate some default comments.
         final Map<String, String> comments = super.getComments();
 
         for ( Map.Entry<String, Method> entry : setters.entrySet() ) {
             final String paramName = entry.getKey();
             if ( comments.containsKey( paramName ) ) {
                 // at the time of implementation, this is not possible,
                 // but who knows? Do not override something already there.
                 continue;
             }
 
             final Method setter = entry.getValue();
 
             final Class<?>[] params = setter.getParameterTypes();
             assert params.length == 1; // already checked at constr.
 
             final Class<?> type = params[ 0 ];
 
             if ( type.isEnum() ) {
                 // generate an automatic comment containing the possible values for enum types
                 final StringBuilder comment = new StringBuilder( "Possible values: " );
                 final Object[] consts = type.getEnumConstants();
 
                 for ( int i = 0; i < consts.length; i++ ) {
                     comment.append( consts[ i ].toString() );
                     if ( i < consts.length - 1 ) comment.append( ", " );
                 }
 
                 comments.put( paramName , comment.toString() );
             }
         }
 
         return comments;
     }

Here is the call graph for this function:

void org.matsim.core.config.ConfigGroup.addParameterToMap	(	final Map< String, String >	map,
		final String	paramName
	)

protectedinherited

Little helper for subclasses (i.e. the ConfigGroups). This method adds the value of the parameter to the given map only if the getValue() method of this Module doesn't return null (Java null-type) or the String representation of null, i.e. "null" or "NULL". If the value is null, the string "null" is added to the map to document the parameter.

Parameters

map
paramName

Definition at line 77 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getValue().

Referenced by org.matsim.core.config.ReflectiveConfigGroup.getParams().

                                                                                             {
         String value = this.getValue(paramName);
         if (!((value == null) || value.equalsIgnoreCase("null"))) {
             map.put(paramName, value);
         } else {
             map.put(paramName, "null");
         }
     }

Here is the call graph for this function:

void org.matsim.core.config.ConfigGroup.checkConsistency ( )

protectedinherited

Check if the set values go well together. This method is usually called after reading the configuration from a file. If an inconsistency is found, a warning or error should be issued and (optionally) a RuntimeException being thrown.

Definition at line 90 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getParameterSets().

                                       {
         // default: just call this method on parameter sets
         for ( Collection<? extends ConfigGroup> sets : getParameterSets().values() ) {
             for ( ConfigGroup set : sets ) set.checkConsistency();
         }
     }

Here is the call graph for this function:

final String org.matsim.core.config.ConfigGroup.getName ( )

inherited

Definition at line 101 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.name.

                                   {
         return this.name;
     }

final String org.matsim.core.config.ConfigGroup.toString ( )

inherited

Definition at line 118 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getName(), and org.matsim.core.config.ConfigGroup.getParams().

Referenced by org.matsim.core.config.ConfigGroup.addParam(), org.matsim.core.config.ReflectiveConfigGroup.getComments(), and org.matsim.core.config.ReflectiveConfigGroup.invokeSetter().

                                    {
         String str = "" ;
         for ( Entry<String, String> entry : this.getParams().entrySet() ) {
             str += "[" + entry.getKey() + "=" + entry.getValue() + "]" ;
         }
         return "[name=" + this.getName() + "]" +
                 "[nOfParams=" + this.getParams().size() + "]" + str ;
     }

Here is the call graph for this function:

ConfigGroup org.matsim.core.config.ConfigGroup.createParameterSet ( final String type )

inherited

Override if parameter sets of a certain type need a special implementation

Definition at line 136 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.ConfigGroup().

                                                              {
         return new ConfigGroup( type );
     }

Here is the call graph for this function:

void org.matsim.core.config.ConfigGroup.addParameterSet ( final ConfigGroup set )

inherited

Definition at line 152 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.checkParameterSet(), and org.matsim.core.config.ConfigGroup.getName().

Referenced by org.matsim.core.config.groups.PlansCalcRouteConfigGroup.addParameterSet(), and org.matsim.core.config.groups.StrategyConfigGroup.addStrategySettings().

                                                        {
         checkParameterSet( set );
         Collection<ConfigGroup> parameterSets = parameterSetsPerType.get( set.getName() );
 
         if ( parameterSets == null ) {
             parameterSets = new ArrayList<>();
             parameterSetsPerType.put( set.getName() ,  parameterSets );
         }
 
         parameterSets.add( set );
     }

Here is the call graph for this function:

boolean org.matsim.core.config.ConfigGroup.removeParameterSet ( final ConfigGroup set )

inherited

Definition at line 164 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.getName().

Referenced by org.matsim.core.config.groups.PlanCalcScoreConfigGroup.addParam(), and org.matsim.core.config.groups.PlanCalcScoreConfigGroup.addScoringParameters().

                                                                {
         final Collection<ConfigGroup> parameterSets = parameterSetsPerType.get( set.getName() );
         return parameterSets != null ?
             parameterSets.remove( set ) :
             false;
     }

Here is the call graph for this function:

void org.matsim.core.config.ConfigGroup.checkParameterSet ( final ConfigGroup set )

protectedinherited

Method called on parameter sets added by the add methods. Can be extended if there are consistency checks to makes, for instance if parameter sets of a given type should be instances of a particular class.

Parameters

set

Definition at line 178 of file ConfigGroup.java.

Referenced by org.matsim.core.config.ConfigGroup.addParameterSet().

                                                             {
         // empty for inheritance
     }

final Collection<? extends ConfigGroup> org.matsim.core.config.ConfigGroup.clearParameterSetsForType ( final String type )

protectedinherited

Useful for instance if default values are provided but should be cleared if user provides values.

Definition at line 186 of file ConfigGroup.java.

Referenced by org.matsim.core.config.groups.PlansCalcRouteConfigGroup.addParameterSet(), and org.matsim.core.config.groups.StrategyConfigGroup.clearStrategySettings().

                                                                                                      {
         return parameterSetsPerType.remove( type );
     }

final Collection<? extends ConfigGroup> org.matsim.core.config.ConfigGroup.getParameterSets ( final String type )

inherited

Definition at line 190 of file ConfigGroup.java.

                                                                                        {
         final Collection<ConfigGroup> sets = parameterSetsPerType.get( type );
         return sets == null ?
             Collections.<ConfigGroup>emptySet() :
             Collections.unmodifiableCollection( sets );
     }

final Map<String, ? extends Collection<? extends ConfigGroup> > org.matsim.core.config.ConfigGroup.getParameterSets ( )

inherited

Definition at line 197 of file ConfigGroup.java.

Referenced by org.matsim.core.config.ConfigGroup.checkConsistency(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getModeRoutingParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.getScoringParametersPerSubpopulation(), and org.matsim.core.config.groups.StrategyConfigGroup.getStrategySettings().

                                                                                              {
         // TODO: immutabilize (including lists)
         // maybe done with what I did below?  kai, sep'16
         
         //      return parameterSetsPerType;
         
         Map<String, Collection<ConfigGroup>> parameterSetsPerType2 = new TreeMap<>() ;
         for ( Entry<String, Collection<ConfigGroup>> entry : parameterSetsPerType.entrySet() ) {
             parameterSetsPerType2.put( entry.getKey(), Collections.unmodifiableCollection(entry.getValue()) ) ;
         }
         return Collections.unmodifiableMap( parameterSetsPerType2 ) ;
     }

final boolean org.matsim.core.config.ConfigGroup.isLocked ( )

inherited

Definition at line 210 of file ConfigGroup.java.

References org.matsim.core.config.ConfigGroup.locked.

Referenced by org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getBeelineDistanceFactors(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getModeRoutingParams(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getOrCreateModeRoutingParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.getScoringParametersPerSubpopulation(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getTeleportedModeFreespeedFactors(), and org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getTeleportedModeSpeeds().

                                     {
         return locked;
     }

void org.matsim.core.config.ConfigGroup.setLocked ( )

inherited

Definition at line 214 of file ConfigGroup.java.

Referenced by org.matsim.core.config.groups.PlansCalcRouteConfigGroup.getOrCreateModeRoutingParams(), org.matsim.core.config.groups.PlanCalcScoreConfigGroup.setLocked(), and org.matsim.pt.router.TransitRouterConfig.TransitRouterConfig().

                             {
         // need to have this non-final to be able to override in order to set delegates.  kai, jun'15
         this.locked = true ;
         for ( Collection<ConfigGroup> parameterSets : this.parameterSetsPerType.values() ) {
             for ( ConfigGroup parameterSet : parameterSets ) {
                 parameterSet.setLocked(); 
             }
         }
     }

final void org.matsim.core.config.ConfigGroup.testForLocked ( )

inherited

Definition at line 224 of file ConfigGroup.java.

Referenced by org.matsim.core.config.groups.PlansCalcRouteConfigGroup.addModeRoutingParams(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.setBeelineDistanceFactor(), org.matsim.core.config.groups.PlansCalcRouteConfigGroup.setTeleportedModeFreespeedFactor(), and org.matsim.core.config.groups.PlansCalcRouteConfigGroup.setTeleportedModeSpeed().

                                       {
         if ( locked ) {
             throw new RuntimeException( "This config group is locked since material from this config group has already been used.") ;
         }
     }

static URL org.matsim.core.config.ConfigGroup.getInputFileURL	(	URL	context,
		String	filename
	)

staticinherited

Definition at line 230 of file ConfigGroup.java.

References org.matsim.core.utils.io.IOUtils.newUrl().

                                                                     {
         if (filename.startsWith("~" + File.separator)) {
             filename = System.getProperty("user.home") + filename.substring(1);
         }
         return IOUtils.newUrl(context, filename);
     }

Here is the call graph for this function:

Member Data Documentation

final String tutorial.programming.reflectiveConfigGroup.MyConfigGroup.GROUP_NAME = "testModule"

static

Definition at line 34 of file MyConfigGroup.java.

Referenced by tutorial.programming.reflectiveConfigGroup.RunReflectiveConfigGroupExample.main().

double tutorial.programming.reflectiveConfigGroup.MyConfigGroup.doubleField = Double.NaN

private

Definition at line 37 of file MyConfigGroup.java.

Id<Link> tutorial.programming.reflectiveConfigGroup.MyConfigGroup.idField = null

private

Definition at line 41 of file MyConfigGroup.java.

Coord tutorial.programming.reflectiveConfigGroup.MyConfigGroup.coordField = null

private

Definition at line 43 of file MyConfigGroup.java.

MyEnum tutorial.programming.reflectiveConfigGroup.MyConfigGroup.enumField = null

private

Definition at line 45 of file MyConfigGroup.java.

String tutorial.programming.reflectiveConfigGroup.MyConfigGroup.nonNull = "some arbitrary default value."

private

Definition at line 47 of file MyConfigGroup.java.

The documentation for this class was generated from the following file:

tutorial/programming/reflectiveConfigGroup/MyConfigGroup.java

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation