org.apache.torque.generator.configuration
Class UnitConfiguration

java.lang.Object
  org.apache.torque.generator.configuration.UnitConfiguration

public class UnitConfiguration
extends Object

Contains all information to run a generation unit. Provides state checking, i.e. getters can only be called after all setters has been called.

Constructor Summary

UnitConfiguration()

Method Summary

ConfigurationHandlers	getConfigurationHandlers() Returns the configuration handlers used to parse the configuration of this generation unit.
String	getDefaultOutputEncoding() Returns the output encoding if no specific encoding has been set in the output.
EntityReferences	getEntityReferences() Returns the entityReferences of the associated configuration unit.
Loglevel	getLoglevel() Returns the Loglevel during generation.
Options	getOptions() Returns the options of the associated configuration unit.
OutletConfiguration	getOutletConfiguration() Returns the configuration of the outlets in this generation unit.
File	getOutputDirectory(String outputDirKey) Returns the output directory for a given output directory key.
Map<String,File>	getOutputDirectoryMap() Returns the output directory map which contains the mapping from output directory key to output directory.
List<Output>	getOutputList() Returns the list of output definitions of the associated configuration unit.
SourceProvider	getOverrideSourceProvider() Returns the source provider which overrides the source provider defined in the control file.
File	getWorkDirectory() Returns the directory where the generator can store internal files.
boolean	isInit() Checks whether the unit configuration is fully initialized.
void	setConfigurationHandlers(ConfigurationHandlers configurationHandlers) Sets the configuration handlers used to parse the configuration of this generation unit.
void	setDefaultOutputEncoding(String defaultOutputEncoding) Sets the output encoding if no specific encoding has been set in the output.
void	setEntityReferences(EntityReferences entityReferences) Sets the entityReferences of the associated configuration unit.
void	setLoglevel(Loglevel loglevel) Sets the Loglevel during generation.
void	setOptions(Options options) Sets the options of the associated configuration unit.
void	setOutletConfiguration(OutletConfiguration outletConfiguration) Sets the outlet configuration of the associated configuration unit.
void	setOutputDirectoryMap(Map<String,File> outputDirectoryMap) Sets the output directory map which contains the mapping from output directory key to output directory.
void	setOutputList(List<Output> outputList) Sets the output activities of the associated configuration unit.
void	setOverrideSourceProvider(SourceProvider overrideSourceProvider) Sets the source provider which overrides the source provider defined in the control file.
void	setWorkDirectory(File workDirectory) Sets the directory where the generator can store internal files.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitConfiguration

public UnitConfiguration()

Method Detail

getOutletConfiguration

public OutletConfiguration getOutletConfiguration()

Returns the configuration of the outlets in this generation unit.

Returns:

the outlet configuration, not null.

Throws:

IllegalStateException - if outletConfiguration was not set.

setOutletConfiguration

public void setOutletConfiguration(OutletConfiguration outletConfiguration)

Sets the outlet configuration of the associated configuration unit.

Parameters:

outletConfiguration - the outlet configuration, not null.

Throws:

NullPointerException - if outletConfiguration is null.

getOptions

public Options getOptions()

Returns the options of the associated configuration unit.

Returns:

the options, not null.

Throws:

IllegalStateException - if options were not yet set.

setOptions

public void setOptions(Options options)

Sets the options of the associated configuration unit.

Parameters:

options - the options, not null.

Throws:

NullPointerException - if options is null.

getOutputDirectory

public File getOutputDirectory(String outputDirKey)

Returns the output directory for a given output directory key.

Parameters:

outputDirKey - the key which output directory should be returned. Null represents the default output directory and is always mapped to a non-null value.

Returns:

the output directory for the key, not null.

Throws:

IllegalStateException - if the default output directory was not yet set.

getOutputDirectoryMap

public Map<String,File> getOutputDirectoryMap()

Returns the output directory map which contains the mapping from output directory key to output directory.

Returns:

the immutable output directory map, not null, contains at least a mapping for the key null.

Throws:

IllegalStateException - if no mapping is contained for the key null.

setOutputDirectoryMap

public void setOutputDirectoryMap(Map<String,File> outputDirectoryMap)

Sets the output directory map which contains the mapping from output directory key to output directory.

Parameters:

outputDirectoryMap - the new output directory map, must contain at least a mapping for the key null.

Throws:

NullPointerException - if outputDirectoryMap is null.

IllegalStateException - if the target directory was not yet set.

getWorkDirectory

public File getWorkDirectory()

Returns the directory where the generator can store internal files.

Returns:

the directory where the generator can store internal files, not null.

Throws:

IllegalStateException - if the target directory was not yet set.

setWorkDirectory

public void setWorkDirectory(File workDirectory)

Sets the directory where the generator can store internal files.

Parameters:

workDirectory - the work directory, not null.

Throws:

NullPointerException - if workDirectory is null.

setOutputList

public void setOutputList(List<Output> outputList)

Sets the output activities of the associated configuration unit.

Parameters:

outputList - the output activities, not null.

Throws:

NullPointerException - if outputFiles is null.

getOutputList

public List<Output> getOutputList()

Returns the list of output definitions of the associated configuration unit.

Returns:

the output definitions, not null.

Throws:

IllegalStateException - if the output definitions were not yet set.

getLoglevel

public Loglevel getLoglevel()

Returns the Loglevel during generation.

Returns:

the Loglevel, not null.

Throws:

IllegalStateException - if the loglevel is not yet set.

setLoglevel

public void setLoglevel(Loglevel loglevel)

Sets the Loglevel during generation.

Parameters:

loglevel - the Loglevel, not null.

Throws:

NullPointerException - if loglevel is set to null.

getConfigurationHandlers

public ConfigurationHandlers getConfigurationHandlers()

Returns the configuration handlers used to parse the configuration of this generation unit.

Returns:

the configuration handlers, not null.

Throws:

IllegalStateException - if configurationHandlers was not set.

setConfigurationHandlers

public void setConfigurationHandlers(ConfigurationHandlers configurationHandlers)

Sets the configuration handlers used to parse the configuration of this generation unit.

Parameters:

configurationHandlers - the configuration handlers, not null.

Throws:

NullPointerException - if configurationHandlers is null.

getOverrideSourceProvider

public SourceProvider getOverrideSourceProvider()

Returns the source provider which overrides the source provider defined in the control file.

Returns:

the overriding source provider, or null to use the source provider defined in the control file.

Throws:

NullPointerException - if overrideSourceFileset was not yet set.

setOverrideSourceProvider

public void setOverrideSourceProvider(SourceProvider overrideSourceProvider)

Sets the source provider which overrides the source provider defined in the control file.

Parameters:

overrideSourceProvider - the override source provider, or null to use the source provider defined in the control file.

getEntityReferences

public EntityReferences getEntityReferences()

Returns the entityReferences of the associated configuration unit.

Returns:

the entityReferences, not null.

Throws:

IllegalStateException - if entityReferences were not yet set.

setEntityReferences

public void setEntityReferences(EntityReferences entityReferences)

Sets the entityReferences of the associated configuration unit.

Parameters:

options - the entityReferences, not null.

Throws:

NullPointerException - if entityReferences is null.

getDefaultOutputEncoding

public String getDefaultOutputEncoding()

Returns the output encoding if no specific encoding has been set in the output.

Returns:

the default output encoding, null for the default platform encoding.

setDefaultOutputEncoding

public void setDefaultOutputEncoding(String defaultOutputEncoding)

Sets the output encoding if no specific encoding has been set in the output.

Parameters:

defaultOutputEncoding - the default output encoding, null for the default platform encoding.

isInit

public boolean isInit()

Checks whether the unit configuration is fully initialized.

Returns:

true if the unit configuration is fully initialized, false otherwise.

toString

public String toString()

Overrides:

toString in class Object