org.xfp.filters.collections
Class MapGenerator

java.lang.Object
  org.xfp.AttributeContainer
      org.xfp.Filter
          org.xfp.filters.collections.MapGenerator

public class MapGenerator

extends Filter

Generates a Map.

Version:

$Id: MapGenerator.java,v 1.1 2004/03/19 15:56:44 flaviotordini Exp $

Author:

Flavio Tordini

Nested Class Summary

Nested classes inherited from class org.xfp.Filter

Filter.OnErrorEnum, Filter.OnLoopErrorEnum

Field Summary

Fields inherited from class org.xfp.AttributeContainer

name, parentContainer

Constructor Summary

MapGenerator()

Method Summary

java.util.Map	execute() Executes this filter.
void	reset() Resets filter status after execution.
void	setEntry(java.lang.String key, java.lang.String value) Adds an entry to the map.

Methods inherited from class org.xfp.Filter

getOnError, initialize, log, newInstance, perform, toString

Methods inherited from class org.xfp.AttributeContainer

configureAttributes, disposeAttributes, getAttributes, getFullName, getName, initializeAttributes

Methods inherited from class java.lang.Object

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

Constructor Detail

MapGenerator

public MapGenerator()

Method Detail

setEntry

public void setEntry(java.lang.String key,
                     java.lang.String value)

Adds an entry to the map.

execute

public java.util.Map execute()
                      throws java.lang.Exception

Executes this filter.

Returns:

A Map of String:String.

Throws:

java.lang.Exception

reset

public void reset()

Description copied from class: Filter

Resets filter status after execution. This method is called after execute(), even in case of exceptions. Since a Filter instance may be reused (and actually is), you must use this method to reset all your class members to their default value.

Specified by:

reset in class Filter

See Also:

Filter.reset()