com.legstar.jaxb.gen.CobolJAXBGenerator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of legstar-distribution
Show all versions of legstar-distribution
Used to create a single distribution for the entire LegStar project.
The newest version!
/*******************************************************************************
* Copyright (c) 2011 LegSem.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the GNU Lesser Public License v2.1
* which accompanies this distribution, and is available at
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* Contributors:
* LegSem - initial API and implementation
******************************************************************************/
package com.legstar.jaxb.gen;
import java.io.File;
import java.io.IOException;
import java.net.URI;
import javax.xml.parsers.ParserConfigurationException;
import org.apache.commons.io.FileUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.BuildListener;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.types.Commandline;
import com.legstar.codegen.CodeGenMakeException;
import com.legstar.codegen.tasks.CommonsLoggingListener;
import com.sun.tools.xjc.XJC2Task;
/**
* A lightweight ant Task which augments the standard JAXB XJC Task.
*
* The basic idea is to collect customization parameters and generate a
* temporary JAXB external customization file.
*
* This is not a replacement for XJC, just a more restricted way of using it for
* legstar to relieve upfront modules, such as cob2xsd, from adding JAXB
* customizations to the XML SChema.
*
*/
public class CobolJAXBGenerator extends Task {
/** Logger. */
private final Log _log = LogFactory.getLog(getClass());
/**
* From XJC, this is the schema file to be compiled. A file name (can be
* relative to the build script base directory), or absolute. Required
* parameter.
*/
private File _xsdFile;
/** From XJC. Generated code will be written under this directory. */
private File _targetDir;
/** Injects the JAXB custom bindings in an XMl SChema. */
private CobolJAXBCustomizer _customizer;
/** Options set. */
private JaxbGenModel _context;
/**
* No args constructor.
*/
public CobolJAXBGenerator() {
_context = new JaxbGenModel();
}
/**
* Constructor from a set of options.
*
* @param context options set
*/
public CobolJAXBGenerator(final JaxbGenModel context) {
_context = context;
}
/**
* Initialize a commons logging logger so that XJC logs gets merged with the
* legstar ones.
*
* @see org.apache.tools.ant.Task#init()
*/
@Override
public void init() {
try {
super.init();
BuildListener logger = new CommonsLoggingListener(_log);
getProject().addBuildListener(logger);
_customizer = new CobolJAXBCustomizer(_context);
} catch (ParserConfigurationException e) {
throw new BuildException(e);
}
}
/**
* The ant method. Generates JAXB classes by invoking XJC.
*/
public void execute() {
log("JAXB generation started.");
checkInput();
// Recreate an XJC task each time because schemas and xjb files are
// cumulative
XJC2Task xjcTask = new XJC2Task();
xjcTask.setProject(getProject());
xjcTask.setTaskName("xjcTask");
// Use external or internal customization
File customizedXsdFile = getXsdFile();
if (_context.isInternalBindings()) {
customizedXsdFile = createInternalCustomization(getXsdFile());
} else {
xjcTask.setBinding(createExternalCustomization(getXsdFile()));
}
xjcTask.setSchema(customizedXsdFile.getAbsolutePath());
xjcTask.setPackage(getJaxbPackageName());
xjcTask.setDestdir(getTargetDir());
xjcTask.setExtension(true);
xjcTask.setRemoveOldOutput(true);
Commandline.Argument argLegStarPlugin = xjcTask.createArg();
argLegStarPlugin.setValue("-Xlegstar-code");
/* Do not perform strict validation of the input schema(s) */
Commandline.Argument argNoValidation = xjcTask.createArg();
argNoValidation.setValue("-nv");
/*
* Avoid headers with timestamps, they make it harder to test for
* changes
*/
Commandline.Argument argNoHeader = xjcTask.createArg();
argNoHeader.setValue("-no-header");
/*
* Don't generate package-info they don't compile on JDK 1.5.
*/
if (isNoPackageInfo()) {
Commandline.Argument argNoPackageInfo = xjcTask.createArg();
argNoPackageInfo.setValue("-npa");
}
/* If ECI compatible mode pass option so that annotator knows about it */
if (isEciCompatible()) {
Commandline.Argument argEci = xjcTask.createArg();
argEci.setValue("-eci");
}
xjcTask.execute();
log("JAXB generation ended.");
}
/**
* Checks that properties set are valid.
*/
protected void checkInput() {
try {
if (_log.isDebugEnabled()) {
_log.debug("checkInput started");
_log.debug("Schema: " + getXsdFile());
_log.debug("TargetDir: " + getTargetDir());
_log.debug("Package name: " + getJaxbPackageName());
_log.debug("xjbModel: " + _context);
}
if (getXsdFile() == null) {
throw (new BuildException(
"You must specify an XML schema file name"));
} else {
if (getXsdFile().exists()) {
if (_log.isDebugEnabled()) {
for (Object line : FileUtils.readLines(getXsdFile())) {
_log.debug(line);
}
}
} else {
throw (new BuildException("XML schema file "
+ getXsdFile().getAbsolutePath()
+ " does not exist"));
}
}
if (getTargetDir() == null) {
throw (new BuildException(
"You must specify a destination directory"));
}
} catch (IOException e) {
throw new BuildException(e);
}
}
/**
* Creates a temporary XML Schema which holds JAXB customization bindings.
*
* @param xsdFile the original XML schema file
* @return the customized XML Schema file
*/
protected File createInternalCustomization(final File xsdFile) {
try {
File tempXsdFile = File.createTempFile("jaxb-schema", ".xsd");
tempXsdFile.deleteOnExit();
_customizer.customize(xsdFile, tempXsdFile);
return tempXsdFile;
} catch (IOException e) {
throw new BuildException(e);
}
}
/**
* Creates a temporary binding file holding the parameters chosen.
*
* @param xsdFile the XML Schema location
* @return the location of the temporary XJB file
*/
public String createExternalCustomization(final File xsdFile) {
try {
File tempXJBFile = File.createTempFile("jaxb-xjb", ".xml");
tempXJBFile.deleteOnExit();
// The schema location needs to be a valid URI
URI xsdURILocation = xsdFile.toURI();
_context.setXsdLocation(xsdURILocation.toString());
_context.generateXjb(tempXJBFile);
return tempXJBFile.getAbsolutePath();
} catch (IOException e) {
throw new BuildException(e);
} catch (CodeGenMakeException e) {
throw new BuildException(e);
}
}
/**
* This is the schema file to be compiled. A file name (can be relative to
* the build script base directory), or absolute.
*
* @return the schema file
*/
public File getXsdFile() {
return _xsdFile;
}
/**
* This is the schema file to be compiled. A file name (can be relative to
* the build script base directory), or absolute.
*
* @param xsdFile schema file
*/
public void setXsdFile(final File xsdFile) {
_xsdFile = xsdFile;
}
/**
* If specified, generated code will be placed under this Java package.
*
* @return Java package name
*/
public String getJaxbPackageName() {
return _context.getJaxbPackageName();
}
/**
* If specified, generated code will be placed under this Java package.
*
* @param jaxbPackageName Java package name
*/
public void setJaxbPackageName(final String jaxbPackageName) {
_context.setJaxbPackageName(jaxbPackageName);
}
/**
* Generated code will be written under this directory.
*
* @return destination directory
*/
public File getTargetDir() {
return _targetDir;
}
/**
* Generated code will be written under this directory.
*
* @param targetDir destination directory
*/
public void setTargetDir(final File targetDir) {
_targetDir = targetDir;
}
/**
* If IsSet Methods should be generated.
*
* @return if IsSet Methods should be generated
*/
public boolean isGenerateIsSetMethod() {
return _context.isGenerateIsSetMethod();
}
/**
* If IsSet Methods should be generated.
*
* @param generateIsSetMethod if IsSet Methods should be generated
*/
public void setGenerateIsSetMethod(final boolean generateIsSetMethod) {
_context.setGenerateIsSetMethod(generateIsSetMethod);
}
/**
* The serialization unique ID. (All JAXB classes must be serializable for
* LegStar).
*
* @return the serialization unique ID. (All JAXB classes must be
* serializable for LegStar)
*/
public long getSerializableUid() {
return _context.getSerializableUid();
}
/**
* The serialization unique ID. (All JAXB classes must be serializable for
* LegStar).
*
* @param serializableUid the serialization unique ID. (All JAXB classes
* must be serializable for LegStar)
*/
public void setSerializableUid(final long serializableUid) {
_context.setSerializableUid(serializableUid);
}
/**
* The prefix to add to type names.
*
* @return the prefix to add to type names
*/
public String getTypeNamePrefix() {
return _context.getTypeNamePrefix();
}
/**
* The prefix to add to type names.
*
* @param typeNamePrefix the prefix to add to type names
*/
public void setTypeNamePrefix(final String typeNamePrefix) {
_context.setTypeNamePrefix(typeNamePrefix);
}
/**
* The suffix to add to type names.
*
* @return the suffix to add to type names
*/
public String getTypeNameSuffix() {
return _context.getTypeNameSuffix();
}
/**
* The suffix to add to type names.
*
* @param typeNameSuffix the suffix to add to type names
*/
public void setTypeNameSuffix(final String typeNameSuffix) {
_context.setTypeNameSuffix(typeNameSuffix);
}
/**
* The prefix to add to element names.
*
* @return the prefix to add to element names
*/
public String getElementNamePrefix() {
return _context.getElementNamePrefix();
}
/**
* The prefix to add to element names.
*
* @param elementNamePrefix the prefix to add to element names
*/
public void setElementNamePrefix(final String elementNamePrefix) {
_context.setElementNamePrefix(elementNamePrefix);
}
/**
* The suffix to add to element names.
*
* @return the suffix to add to element names
*/
public String getElementNameSuffix() {
return _context.getElementNameSuffix();
}
/**
* The suffix to add to element names.
*
* @param elementNameSuffix the suffix to add to element names
*/
public void setElementNameSuffix(final String elementNameSuffix) {
_context.setElementNameSuffix(elementNameSuffix);
}
/**
* whether internal bindings or and external binding should be used.
*
* @return whether internal bindings or and external binding should be used
*/
public boolean isInternalBindings() {
return _context.isInternalBindings();
}
/**
* Whether internal bindings or and external binding should be used.
*
* @param internalBindings whether internal bindings or and external binding
* should be used
*/
public void setInternalBindings(final boolean internalBindings) {
_context.setInternalBindings(internalBindings);
}
/**
* Whether the ECI naming conventions should be used.
*
* @return Whether the ECI naming conventions should be used
*/
public boolean isEciCompatible() {
return _context.isEciCompatible();
}
/**
* Whether the ECI naming conventions should be used.
*
* @param eciCompatible whether the ECI naming conventions should be used
*/
public void setEciCompatible(final boolean eciCompatible) {
_context.setEciCompatible(eciCompatible);
}
/**
* Prevents generation of JAXB package-info.java which does not compile
* under JDK 1.5.
*
* @return true if we should not generate package-info.java
*/
public boolean isNoPackageInfo() {
return _context.isNoPackageInfo();
}
/**
* Prevents generation of JAXB package-info.java which does not compile
* under JDK 1.5.
*
* @param noPackageInfo true if we should not generate package-info.java
*/
public void setNoPackageInfo(boolean noPackageInfo) {
_context.setNoPackageInfo(noPackageInfo);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy