shared
Class Env_Inducer

java.lang.Object
  |
  +--shared.Env_Inducer

public class Env_Inducer

extends java.lang.Object

The Env_Inducer class provides functions for creating Inducer objects of any specific type.

Constructor Summary

Env_Inducer()
Creates a new instance of Env_Inducer.

Method Summary

static BaseInducer	env_inducer() Returns an Inducer object of an unspecified type.
static BaseInducer	env_inducer(java.lang.String prefix) Creates a new instance of Env_Inducer
static BaseInducer	make_disc_filter(java.lang.String prefix, BaseInducer innerInducer) Creates a discrete filter wrapper around a specified inducer.
static java.lang.String	name_from_value(java.lang.String inducerType) Returns the name associated with the specified type.
static BaseInducer	search_inducers(java.lang.String prefix, java.lang.String inducerType, java.lang.String inducerName) Creates a search wrapper of the specified type.

Methods inherited from class java.lang.Object

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

Constructor Detail

Env_Inducer

public Env_Inducer()

Creates a new instance of Env_Inducer. Should not be accessable.

Method Detail

env_inducer

public static BaseInducer env_inducer()

Returns an Inducer object of an unspecified type.

Returns:

An Inducer object of an unspecified type.

name_from_value

public static java.lang.String name_from_value(java.lang.String inducerType)

Returns the name associated with the specified type.

Parameters:

inducerType - Prefix for Inducer options.

Returns:

The name of the Inducer type.

env_inducer

public static BaseInducer env_inducer(java.lang.String prefix)

Creates a new instance of Env_Inducer

Parameters:

prefix - Prefix for Inducer options. Should correspond to the Inducer name.

Returns:

An Inducer of the type corresponding to the name specified.

make_disc_filter

public static BaseInducer make_disc_filter(java.lang.String prefix,
                                           BaseInducer innerInducer)

Creates a discrete filter wrapper around a specified inducer.

Parameters:

prefix - Prefix for Inducer options.

innerInducer - The Inducer this wrapper contains.

Returns:

A discretly filtered Inducer.

search_inducers

public static BaseInducer search_inducers(java.lang.String prefix,
                                          java.lang.String inducerType,
                                          java.lang.String inducerName)

Creates a search wrapper of the specified type.

Parameters:

prefix - Prefix for Inducer options.

inducerType - The type of search wrapping Inducer.

inducerName - The name of the search wrapping Inducer.

Returns:

The search wrapping Inducer.