org.apache.torque.generator.configuration
Class UnitDescriptor

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

public class UnitDescriptor
extends Object

Contains all necessary information about a generation unit.

Nested Class Summary

static class

UnitDescriptor.Packaging Possible packaging forms of a unit of generation.

Constructor Summary

UnitDescriptor(UnitDescriptor.Packaging packaging, ProjectPaths projectPaths, TorqueGeneratorPaths configurationPaths)
Constructor without inheritance, override options, overrideSourceFileset and loglevel.

Method Summary

TorqueGeneratorPaths	getConfigurationPaths() Returns the paths in the configuration of this generation unit.
String	getDefaultOutputEncoding() Returns the output encoding if no specific encoding has been set in the output.
UnitDescriptor	getInheritsFrom() Returns the descriptor of the generation unit from which this generation unit inherits, or null if this generation unit does not inherit from another generation unit.
Loglevel	getLoglevel() Returns the log level overriding the loglevel defined in the configuration unit.
OptionsConfiguration	getOverrideOptions() Returns the configuration of the overriding options, if any.
SourceProvider	getOverrideSourceProvider() Returns the source provider overriding the source defined in the control file, or null if the control file definition is not overridden.
UnitDescriptor.Packaging	getPackaging() Returns the packaging of the unit of generation.
ProjectPaths	getProjectPaths() Returns the paths which the Torque generator must know about the surrounding project.
void	setDefaultOutputEncoding(String defaultOutputEncoding) Sets the output encoding which is used if no specific encoding has been set in the output.
void	setInheritsFrom(UnitDescriptor inheritsFrom) Sets the descriptor of the generation unit from which this generation unit inherits.
void	setLoglevel(Loglevel loglevel) Sets the log level overriding the loglevel defined in the configuration unit.
void	setOverrideOptions(OptionsConfiguration overrideOptions) Sets the configuration of the overriding options, if any.
void	setOverrideSourceProvider(SourceProvider overrideSourceProvider) Sets the source provider overriding the source defined in the control file.

Methods inherited from class java.lang.Object

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

Constructor Detail

UnitDescriptor

public UnitDescriptor(UnitDescriptor.Packaging packaging,
                      ProjectPaths projectPaths,
                      TorqueGeneratorPaths configurationPaths)

Constructor without inheritance, override options, overrideSourceFileset and loglevel.

Parameters:

packaging - The packaging of the generation unit, not null.

projectPaths - The paths the Torque generator must know about the surrounding project, not null.

configurationPaths - The paths within the configuration of the configuration unit, not null.

Method Detail

getPackaging

public UnitDescriptor.Packaging getPackaging()

Returns the packaging of the unit of generation.

Returns:

the packaging of the unit of generation, not null.

getProjectPaths

public ProjectPaths getProjectPaths()

Returns the paths which the Torque generator must know about the surrounding project.

Returns:

the paths of the surrounding project, not null.

getConfigurationPaths

public TorqueGeneratorPaths getConfigurationPaths()

Returns the paths in the configuration of this generation unit.

Returns:

the paths in the configuration of this generation unit, not null.

getInheritsFrom

public UnitDescriptor getInheritsFrom()

Returns the descriptor of the generation unit from which this generation unit inherits, or null if this generation unit does not inherit from another generation unit.

Returns:

the parents unit descriptor, or null if no parent exists.

setInheritsFrom

public void setInheritsFrom(UnitDescriptor inheritsFrom)

Sets the descriptor of the generation unit from which this generation unit inherits.

Parameters:

inheritsFrom - the parents unit descriptor, or null if no parent exists.

getOverrideSourceProvider

public SourceProvider getOverrideSourceProvider()

Returns the source provider overriding the source defined in the control file, or null if the control file definition is not overridden.

Returns:

the overriding source provider, or null.

setOverrideSourceProvider

public void setOverrideSourceProvider(SourceProvider overrideSourceProvider)

Sets the source provider overriding the source defined in the control file.

Parameters:

overrideSourceProvider - the overriding source provider, or null if the control file definition is not overridden.

getOverrideOptions

public OptionsConfiguration getOverrideOptions()

Returns the configuration of the overriding options, if any.

Returns:

the configuration of the overriding options, or null.

setOverrideOptions

public void setOverrideOptions(OptionsConfiguration overrideOptions)

Sets the configuration of the overriding options, if any.

Parameters:

overrideOptions - the configuration of the overriding options, or null.

getLoglevel

public Loglevel getLoglevel()

Returns the log level overriding the loglevel defined in the configuration unit.

Returns:

the log level, or null.

setLoglevel

public void setLoglevel(Loglevel loglevel)

Sets the log level overriding the loglevel defined in the configuration unit.

Parameters:

loglevel - the log level, or 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 which is used if no specific encoding has been set in the output.

Parameters:

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