org.apache.cayenne.gen.DefaultClassGenerator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of cayenne-client-nodeps
Show all versions of cayenne-client-nodeps
Cayenne Object Persistence Framework
/*****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
****************************************************************/
package org.apache.cayenne.gen;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.ArrayList;
import java.util.List;
import org.apache.cayenne.map.DataMap;
import org.apache.cayenne.map.ObjEntity;
import org.apache.cayenne.tools.NamePatternMatcher;
/**
* Extends MapClassGenerator to allow target-specific filesystem locations where the files
* should go. Adds "execute" method that performs class generation based on the internal
* state of this object.
*
* @author Andrei Adamchik
*/
public class DefaultClassGenerator extends MapClassGenerator {
protected File destDir;
protected boolean overwrite;
protected boolean usePkgPath = true;
protected boolean makePairs = true;
protected String template;
protected String superTemplate;
protected long timestamp = System.currentTimeMillis();
private static final String WILDCARD = "*";
protected String outputPattern = "*.java";
/**
* Stores the encoding of the generated file.
*
* @since 1.2
*/
protected String encoding;
public DefaultClassGenerator() {
}
/**
* Creates class generator and initializes it with DataMap. This will ensure
* generation of classes for all ObjEntities in the DataMap.
*/
public DefaultClassGenerator(DataMap dataMap) {
this(dataMap, new ArrayList(dataMap.getObjEntities()));
}
/**
* Creates class generator and initializes it with the list of ObjEntities that will
* be used in class generation.
*/
public DefaultClassGenerator(DataMap dataMap, List selectedObjEntities) {
super(dataMap, selectedObjEntities);
}
/**
* Creates class generator and initializes it with the list of ObjEntities that will
* be used in class generation.
*
* @deprecated Use DefaultClassGenerator(DataMap, List) to provide support for v1.2
* templates.
*/
public DefaultClassGenerator(List selectedObjEntities) {
super(selectedObjEntities);
}
/** Runs class generation. */
public void execute() throws Exception {
validateAttributes();
if (makePairs) {
String t = getTemplateForPairs();
String st = getSupertemplateForPairs();
generateClassPairs(t, st, MapClassGenerator.SUPERCLASS_PREFIX);
}
else {
generateSingleClasses(
getTemplateForSingles(),
MapClassGenerator.SUPERCLASS_PREFIX);
}
}
/**
* Validates the state of this class generator. Throws exception if it is in
* inconsistent state. Called internally from "execute".
*/
public void validateAttributes() throws Exception {
if (destDir == null) {
throw new Exception("'destDir' attribute is missing.");
}
if (!destDir.isDirectory()) {
throw new Exception("'destDir' is not a directory.");
}
if (!destDir.canWrite()) {
throw new Exception("Do not have write permissions for " + destDir);
}
if ((false == VERSION_1_1.equals(versionString))
&& (false == VERSION_1_2.equals(versionString))) {
throw new Exception("'version' must be '"
+ VERSION_1_1
+ "' or '"
+ VERSION_1_2
+ "'.");
}
}
/**
* Sets the destDir.
*/
public void setDestDir(File destDir) {
this.destDir = destDir;
}
/**
* Sets overwrite property.
*/
public void setOverwrite(boolean overwrite) {
this.overwrite = overwrite;
}
/**
* Sets makepairs property.
*/
public void setMakePairs(boolean makePairs) {
this.makePairs = makePairs;
}
/**
* Sets template property.
*
* @deprecated since 1.2 use {@link #setTemplate(String)} as custom template can also
* be looked up in CLASSPATH.
*/
public void setTemplate(File template) {
this.template = template != null ? template.getPath() : null;
}
/**
* Sets superTemplate property.
*
* @deprecated since 1.2 use {@link #setSuperTemplate(String)} as custom template can
* also be looked up in CLASSPATH.
*/
public void setSuperTemplate(File superTemplate) {
this.superTemplate = superTemplate != null ? superTemplate.getPath() : null;
}
/**
* Sets template property.
*/
public void setTemplate(String template) {
this.template = template;
}
/**
* Sets superTemplate property.
*/
public void setSuperTemplate(String superTemplate) {
this.superTemplate = superTemplate;
}
/**
* Sets usepkgpath property.
*/
public void setUsePkgPath(boolean usePkgPath) {
this.usePkgPath = usePkgPath;
}
/**
* Sets outputPattern property.
*/
public void setOutputPattern(String outputPattern) {
this.outputPattern = outputPattern;
}
public void closeWriter(Writer out) throws Exception {
out.close();
}
/**
* Opens a Writer to write generated output. Writer encoding is determined from the
* value of the "encoding" property.
*/
public Writer openWriter(ObjEntity entity, String pkgName, String className)
throws Exception {
File outFile = (className.startsWith(SUPERCLASS_PREFIX)) ? fileForSuperclass(
pkgName,
className) : fileForClass(pkgName, className);
if (outFile == null) {
return null;
}
// return writer with specified encoding
FileOutputStream out = new FileOutputStream(outFile);
return (getEncoding() != null)
? new OutputStreamWriter(out, getEncoding())
: new OutputStreamWriter(out);
}
/**
* Returns a target file where a generated superclass must be saved. If null is
* returned, class shouldn't be generated.
*/
protected File fileForSuperclass(String pkgName, String className) throws Exception {
String filename = NamePatternMatcher.replaceWildcardInStringWithString(
WILDCARD,
outputPattern,
className);
File dest = new File(mkpath(destDir, pkgName), filename);
// Ignore if the destination is newer than the map
// (internal timestamp), i.e. has been generated after the map was
// last saved AND the template is older than the destination file
if (dest.exists() && !isOld(dest)) {
if (superTemplate == null) {
return null;
}
File superTemplateFile = new File(superTemplate);
if (superTemplateFile.lastModified() < dest.lastModified()) {
return null;
}
}
return dest;
}
/**
* Returns a target file where a generated class must be saved. If null is returned,
* class shouldn't be generated.
*/
protected File fileForClass(String pkgName, String className) throws Exception {
String filename = NamePatternMatcher.replaceWildcardInStringWithString(
WILDCARD,
outputPattern,
className);
File dest = new File(mkpath(destDir, pkgName), filename);
if (dest.exists()) {
// no overwrite of subclasses
if (makePairs) {
return null;
}
// skip if said so
if (!overwrite) {
return null;
}
// Ignore if the destination is newer than the map
// (internal timestamp), i.e. has been generated after the map was
// last saved AND the template is older than the destination file
if (!isOld(dest)) {
if (template == null) {
return null;
}
File templateFile = new File(template);
if (templateFile.lastModified() < dest.lastModified()) {
return null;
}
}
}
return dest;
}
/**
* Returns true if file parameter is older than internal timestamp of
* this class generator.
*/
protected boolean isOld(File file) {
return file.lastModified() <= getTimestamp();
}
/**
* Returns a File object corresponding to a directory where files that belong to
* pkgName package should reside. Creates any missing diectories below
* dest.
*/
protected File mkpath(File dest, String pkgName) throws Exception {
if (!usePkgPath || pkgName == null) {
return dest;
}
String path = pkgName.replace('.', File.separatorChar);
File fullPath = new File(dest, path);
if (!fullPath.isDirectory() && !fullPath.mkdirs()) {
throw new Exception("Error making path: " + fullPath);
}
return fullPath;
}
/**
* Returns template file path for Java class when generating single classes.
*/
protected String getTemplateForSingles() throws IOException {
return (template != null) ? template : defaultSingleClassTemplate();
}
/**
* Returns template file path for Java subclass when generating class pairs.
*/
protected String getTemplateForPairs() throws IOException {
return (template != null) ? template : defaultSubclassTemplate();
}
/**
* Returns template file path for Java superclass when generating class pairs.
*/
protected String getSupertemplateForPairs() throws IOException {
return (superTemplate != null) ? superTemplate : defaultSuperclassTemplate();
}
/**
* Returns internal timestamp of this generator used to make decisions about
* overwriting individual files.
*/
public long getTimestamp() {
return timestamp;
}
public void setTimestamp(long timestamp) {
this.timestamp = timestamp;
}
/**
* Returns file encoding for the generated files.
*
* @since 1.2
*/
public String getEncoding() {
return encoding;
}
/**
* Sets file encoding. If set to null, default system encoding will be used.
*
* @since 1.2
*/
public void setEncoding(String encoding) {
this.encoding = encoding;
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy