Resource.java
package org.andromda.core.cartridge;
import java.io.File;
import java.text.MessageFormat;
import org.andromda.core.configuration.NamespaceProperties;
import org.andromda.core.configuration.Namespaces;
import org.andromda.core.configuration.Property;
import org.apache.commons.lang.StringUtils;
/**
* <p/>
* This class implements the <code><resource></code> tag in a cartridge descriptor file and represents the base
* cartridge resource element. </p>
*
* @author Chad Brandon
* @author Bob Fields
*/
public class Resource
{
/**
* Stores the output location logical name.
*/
private String outlet;
/**
* Gets the logical location to which output from this resource will be written.
*
* @return Returns the outlet.
*/
public String getOutlet()
{
return outlet;
}
/**
* Sets the logical location to which output from this resource will be written.
*
* @param outlet The outlet to set.
*/
public void setOutlet(final String outlet)
{
this.outlet = outlet;
}
/**
* Stores the outputCondition that must evaluate to true for the template to be written.
*/
private String outputCondition;
/**
* Sets the outputCondition that must evaluate to true in order for the template to be written.
*
* @param outputCondition the template engine outputCondition.
*/
public void setOutputCondition(final String outputCondition)
{
this.outputCondition = outputCondition;
}
/**
* Gets the outputCondition that must evaluate to true in order for the template to be written.
*
* @return the template engine outputCondition.
*/
public String getOutputCondition()
{
return this.outputCondition;
}
/**
* Returns the fully qualified name of the resource output to be written, this means: <ul> <li>the output pattern
* has been translated</li> <li>the output directory name has been prepended</li> </ul>
*
* @param arguments any arguments to be inserted into the MessageFormat style messages.
* @param directory the directory to which output will be written.
* @param outputPattern if undefined, the value of {@link #getOutputPattern()} will be used.
* @return File absolute directory.
*/
public File getOutputLocation(
final Object[] arguments,
final File directory,
String outputPattern)
{
File file = null;
// - clean any whitespace off the arguments
if (directory != null && arguments != null && arguments.length > 0)
{
for (int ctr = 0; ctr < arguments.length; ctr++)
{
arguments[ctr] = StringUtils.trimToEmpty(String.valueOf(arguments[ctr]));
}
if (StringUtils.isBlank(outputPattern))
{
outputPattern = this.getOutputPattern();
}
String outputFileName;
try
{
outputFileName = MessageFormat.format(
outputPattern,
arguments);
}
catch (final Exception exception)
{
// - means the output pattern can't be parsed (but we still
// want to output the bad path anyway)
outputFileName = outputPattern;
}
file = new File(
directory,
outputFileName);
}
return file;
}
/**
* Stores whether or not the resource should be overwritten.
*/
private boolean overwrite = false;
/**
* Tells us whether output files produced by this resource should be overwritten if they already exist. Overwriting
* can be turned on and off for entire cartridges by setting the <code>overwrite</code> property in a namespace.
* This is useful for cartridge developers when they always want produced resources to be overwritten at first.
*
* @return Returns the overwrite.
*/
public boolean isOverwrite()
{
final Property property =
Namespaces.instance().getProperty(
this.getCartridge().getNamespace(),
NamespaceProperties.OVERWRITE,
false);
if (property != null)
{
this.overwrite = Boolean.valueOf(property.getValue());
}
return this.overwrite;
}
/**
* Sets whether output files produced by this resource should be overwritten if they already exist.
*
* @param overwrite The overwrite to set.
*/
public void setOverwrite(final boolean overwrite)
{
this.overwrite = overwrite;
}
/**
* Whether or not a last modified check should be performed before writing the resource.
*/
private boolean lastModifiedCheck;
/**
* Sets whether or not a last modified check should be performed before writing the resource.
*
* @param lastModifiedCheck true/false
*/
public void setLastModifiedCheck(final boolean lastModifiedCheck)
{
this.lastModifiedCheck = lastModifiedCheck;
}
/**
* Whether or not a last modified check should be performed before writing the resource.
*
* @return true/false
*/
public boolean isLastModifiedCheck()
{
return this.lastModifiedCheck;
}
/**
* Store the path to a cartridge resource.
*/
private String path;
/**
* Gets the path to the cartridge resource.
*
* @return Returns the path.
*/
public String getPath()
{
return this.path;
}
/**
* Sets the path to the cartridge resource.
*
* @param path The path to set.
*/
public void setPath(final String path)
{
this.path = path;
}
/**
* Stores the cartridge that owns this resource.
*/
private Cartridge cartridge;
/**
* The cartridge that owns this resource.
*
* @return Returns the owning cartridge.
*/
public Cartridge getCartridge()
{
return this.cartridge;
}
/**
* Sets the Cartridge parent to which this Resource belongs.
*
* @param cartridge the parent Cartridge to set.
*/
public void setCartridge(final Cartridge cartridge)
{
this.cartridge = cartridge;
}
/**
* Stores the output pattern for which the resource(s) should be written.
*/
private String outputPattern;
/**
* Sets the pattern that is used to build the name of the output file.
*
* @param outputPattern the pattern in java.text.MessageFormat syntax
*/
public void setOutputPattern(final String outputPattern)
{
this.outputPattern = outputPattern;
}
/**
* Gets the pattern that is used to build the name of the output file.
*
* @return String the pattern in java.text.MessageFormat syntax
*/
public String getOutputPattern()
{
return StringUtils.trimToEmpty(this.outputPattern);
}
/**
* @see java.lang.Object#toString()
*/
@Override
public String toString()
{
StringBuilder builder = new StringBuilder();
builder.append(super.toString());
builder.append(" [outlet=").append(this.outlet);
builder.append(", outputCondition=").append(this.outputCondition);
builder.append(", overwrite=").append(this.overwrite);
builder.append(", lastModifiedCheck=").append(this.lastModifiedCheck);
builder.append(", path=").append(this.path);
builder.append(", cartridge=").append(this.cartridge);
builder.append(", outputPattern=").append(this.outputPattern).append("]");
return builder.toString();
}
}