org.openmdx.application.mof.mapping.java.StandardMetaDataMapper Maven / Gradle / Ivy
/*
* ====================================================================
* Project: openMDX/Core, http://www.openmdx.org/
* Description: JPA3 Meta Data Mapper
* Owner: OMEX AG, Switzerland, http://www.omex.ch
* ====================================================================
*
* This software is published under the BSD license as listed below.
*
* Copyright (c) 2005-2013, OMEX AG, Switzerland
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted provided that the following
* conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* * Neither the name of the openMDX team nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
* CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
* INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
* ------------------
*
* This product includes or is based on software developed by other
* organizations as listed in the NOTICE file.
*/
package org.openmdx.application.mof.mapping.java;
import java.io.ByteArrayOutputStream;
import java.io.CharArrayWriter;
import java.io.PrintWriter;
import java.io.Writer;
import java.util.Arrays;
import java.util.Date;
import java.util.List;
import org.omg.mof.spi.Identifier;
import org.omg.mof.spi.Names;
import org.openmdx.application.mof.mapping.cci.AttributeDef;
import org.openmdx.application.mof.mapping.cci.ClassDef;
import org.openmdx.application.mof.mapping.cci.MetaData_1_0;
import org.openmdx.application.mof.mapping.cci.ReferenceDef;
import org.openmdx.application.mof.mapping.cci.StructuralFeatureDef;
import org.openmdx.application.mof.mapping.java.metadata.ClassMetaData;
import org.openmdx.application.mof.mapping.java.metadata.ColumnMetaData;
import org.openmdx.application.mof.mapping.java.metadata.FieldMetaData;
import org.openmdx.application.mof.mapping.java.metadata.FieldPersistenceModifier;
import org.openmdx.application.mof.mapping.java.metadata.InheritanceMetaData;
import org.openmdx.application.mof.mapping.java.metadata.InheritanceStrategy;
import org.openmdx.application.mof.mapping.java.metadata.JoinMetaData;
import org.openmdx.application.mof.mapping.java.metadata.MetaData_2_0;
import org.openmdx.application.mof.mapping.java.metadata.PackageMetaData;
import org.openmdx.base.accessor.cci.SystemAttributes;
import org.openmdx.base.exception.ServiceException;
import org.openmdx.base.mof.cci.ModelElement_1_0;
import org.openmdx.base.mof.cci.Model_1_0;
import org.openmdx.base.mof.cci.PrimitiveTypes;
import org.w3c.format.DateTimeFormat;
/**
* JPA3 Meta Data Mapper
*/
public class StandardMetaDataMapper extends AbstractMetaDataMapper {
/**
* Constructor
*/
public StandardMetaDataMapper(
ModelElement_1_0 classDef,
Writer writer,
Model_1_0 model,
Format format,
String packageSuffix,
String sliceClassName,
MetaData_1_0 metaData,
PrimitiveTypeMapper primitiveTypeMapper,
ObjectRepositoryMetadataPlugin plugin
) throws ServiceException {
super(
classDef,
writer,
model,
format,
packageSuffix,
sliceClassName,
metaData,
primitiveTypeMapper,
plugin
);
}
//-----------------------------------------------------------------------
protected String ormTableName(
) throws ServiceException {
return this.classMetaData == null || this.classMetaData.getTable() == null ?
this.getTableName(this.qualifiedClassName) :
DEFAULT_IDENTIFIER_MAPPING.equals(this.classMetaData.getTable()) ?
null :
(this.sliceClassName == null ? this.classMetaData.getTable() : this.plugin.getSliceTableName(this.classMetaData.getTable()));
}
//-----------------------------------------------------------------------
protected boolean isPersistent(
StructuralFeatureDef featureDef
) throws ServiceException {
FieldMetaData fieldMetaData = getFieldMetaData(featureDef.getQualifiedName());
return fieldMetaData == null || fieldMetaData.getPersistenceModifier() == null ? (
!featureDef.isDerived() &&
!this.isPersistenceAware(this.getClassDef(featureDef.getQualifiedTypeName()))
) : fieldMetaData.getPersistenceModifier() == FieldPersistenceModifier.PERSISTENT;
}
//-----------------------------------------------------------------------
protected boolean isVersion(
StructuralFeatureDef featureDef
) throws ServiceException {
FieldMetaData fieldMetaData = getFieldMetaData(featureDef.getQualifiedName());
return fieldMetaData != null && fieldMetaData.getPersistenceModifier() == FieldPersistenceModifier.VERSION;
}
//-----------------------------------------------------------------------
protected String getDiscriminatorValue(
) {
return this.classDef.getQualifiedName();
}
//-----------------------------------------------------------------------
@Override
public void mapReference(
ReferenceDef featureDef
) throws ServiceException {
boolean isPersistent = this.isPersistent(featureDef);
String objectFieldName = Identifier.ATTRIBUTE_NAME.toIdentifier(featureDef.getName());
// Composite association
if(featureDef.isComposition()) {
// No member for composites. Composites are retrieved by query
}
// Shared association
else if(featureDef.isShared()) {
if(isPersistent) {
this.pwOneToManyRelationships.print(" ");
FieldMetaData fieldMetaData = getFieldMetaData(featureDef.getQualifiedName());
JoinMetaData joinMetaData = fieldMetaData == null ? null : fieldMetaData.getJoin();
String tableName = joinMetaData == null || !DEFAULT_IDENTIFIER_MAPPING.equals(joinMetaData.getTable()) ? (
joinMetaData == null || joinMetaData.getTable() == null ? getTableName(
Arrays.asList(
featureDef.getQualifiedAssociationName().split(":")
)
) : joinMetaData.getTable()
) : null;
if(tableName != null) {
this.pwOneToManyRelationships.print(" ");
String parentColumnName = this.toColumnName(featureDef.getExposedEndName());
String childColumnName = this.toColumnName(featureDef.getName());
this.pwOneToManyRelationships.print(" ");
if(
(columnMetaData == null) ||
!DEFAULT_IDENTIFIER_MAPPING.equals(columnMetaData.getName())
) {
this.printColumn(
this.pwBasicAttributes,
"column",
columnMetaData,
toColumnName(objectFieldName),
null,
Boolean.TRUE, // allowsNull
-1
);
}
this.pwBasicAttributes.println(" ");
}
else {
this.pwBasicAttributes.print(" ");
if(
(columnMetaData == null) ||
!DEFAULT_IDENTIFIER_MAPPING.equals(columnMetaData.getName())
) {
this.printColumn(
this.pwBasicAttributes,
"column",
columnMetaData,
toColumnName(objectFieldName),
null,
Boolean.TRUE, // allowsNull
-1
);
}
this.pwBasicAttributes.println(" ");
}
}
else {
this.pwTransientAttributes.print(" ");
FieldMetaData fieldMetaData = getFieldMetaData(featureDef.getQualifiedName());
ColumnMetaData columnMetaData = fieldMetaData == null ? null : fieldMetaData.getColumn();
boolean specifyColumnName =
columnMetaData == null ||
!DEFAULT_IDENTIFIER_MAPPING.equals(columnMetaData.getName());
if(specifyColumnName) {
String columnName = columnMetaData != null && columnMetaData.getName() != null ?
columnMetaData.getName() :
toColumnName(featureDef.getName());
this.pw.print(" ");
if(isPersistent) {
this.printColumn(
this.pwBasicAttributes,
fieldMetaData.getColumn(),
toColumnName(featureDef.getName()),
null, // defaultScale
Boolean.TRUE,
i
);
}
this.pwBasicAttributes.println(" ");
}
else {
String fieldName = Identifier.ATTRIBUTE_NAME.toIdentifier(featureDef.getName());
this.pwTransientAttributes.print(" ");
FieldMetaData fieldMetaData = getFieldMetaData(featureDef.getQualifiedName());
ColumnMetaData columnMetaData = fieldMetaData == null ? null : fieldMetaData.getColumn();
if(
columnMetaData == null ||
!DEFAULT_IDENTIFIER_MAPPING.equals(columnMetaData.getName()) ||
columnMetaData.getLength() != null ||
columnMetaData.getScale() != null ||
columnMetaData.getJdbcType() != null
) {
this.printColumn(
this.pwBasicAttributes,
columnMetaData,
toColumnName(featureDef.getName()),
PrimitiveTypes.DECIMAL.equals(featureDef.getQualifiedTypeName()) ?
this.plugin.getDecimalScale(
this.qualifiedClassName,
featureDef.getName()
) :
null,
Boolean.TRUE,
-1
);
}
this.pwBasicAttributes.println(" ");
} else if (!isVersion(featureDef)){
this.pwTransientAttributes.print(" ");
// table
InheritanceStrategy inheritanceStrategy = this.getInheritanceStrategy();
if (
(this.classMetaData.getTable() != null) ||
(InheritanceStrategy.JOINED == inheritanceStrategy) || (
isBaseClass() &&
InheritanceStrategy.TABLE_PER_CLASS != inheritanceStrategy
)
) {
this.pw.print(" ");
this.pw.print(this.getDiscriminatorValue());
this.pw.println(" ");
// discriminator-column
this.pw.print(" ");
// version
if(
isBaseClass &&
(this.classMetaData.getBaseClass() == null) &&
this.isInstanceOf("org:openmdx:base:BasicObject")
) {
this.pwVersionAttributes.print(" ");
this.pwVersionAttributes.print(" ");
this.printColumn(
this.pw,
identityColumnMetaData,
this.toColumnName(InstanceMapper.JDO_IDENTITY_MEMBER),
null,
null,
-1
);
this.pw.println(" ");
}
// parent
if(this.hasContainer()) {
this.pwBasicAttributes.print(" ");
FieldMetaData fieldMetaDataContainer = this.classMetaData.getFieldMetaData(
this.directCompositeReference.getExposedEndName()
);
this.printColumn(
this.pwBasicAttributes,
"column",
fieldMetaDataContainer == null ?
null :
fieldMetaDataContainer.getColumn(),
this.toColumnName(this.directCompositeReference.getExposedEndName()),
null,
null,
-1
);
this.pwBasicAttributes.println(" ");
}
}
// openmdxjdoSlices
if(isSliceHolder && !sliceIsBaseClass) {
this.pwOneToManyRelationships.print(" ");
this.pwOneToManyRelationships.print("
//
String tag = "id";
this.pw.print(" <" + tag);
printAttribute(this.pw, "name", InstanceMapper.JDO_IDENTITY_MEMBER);
this.pw.println(">");
this.printColumn(
this.pw,
identityColumnMetaData,
this.toColumnName(InstanceMapper.JDO_IDENTITY_MEMBER),
null,
null,
-1
);
this.pw.println(" ");
//
//
FieldMetaData indexFieldMetaData = this.classMetaData.getFieldMetaData(
InstanceMapper.INDEX_MEMBER
);
ColumnMetaData indexColumnMetaData = indexFieldMetaData == null ?
null :
indexFieldMetaData.getColumn();
this.pw.print(" <" + tag);
printAttribute(this.pw, "name", InstanceMapper.INDEX_MEMBER);
this.pw.println(">");
this.printColumn(
this.pw,
indexColumnMetaData,
this.toColumnName(InstanceMapper.INDEX_MEMBER),
null,
null,
-1
);
this.pw.println(" ");
//
//
this.pwManyToOneRelationships.print(" ");
this.pwManyToOneRelationships.print(" ");
pw.println("");
pw.println(" FIELD ");
}
//-----------------------------------------------------------------------
/**
* Print the XML file footer
*/
public static void fileFooter(
PrintWriter pw
) {
pw.print("");
}
//-----------------------------------------------------------------------
private void embed(
StandardMetaDataMapper that
) throws ServiceException {
that.mapSliceClassEnd();
that.pw.flush();
if(that.process) {
this.pw.write(((CharArrayWriter) that.writer).toCharArray());
}
}
//-----------------------------------------------------------------------
public static void printAttribute(
PrintWriter pw,
String name,
Object value
) {
if(value != null) {
pw.print(' ');
pw.print(name);
pw.print('=');
pw.print('"');
pw.print(value);
pw.print('"');
}
}
//-----------------------------------------------------------------------
/**
* Convert a model name to a database name
*
* @param fieldName
* @param size
*
* @return
*/
protected String toColumnName(
String fieldName
) {
return fieldName.equals(InstanceMapper.INDEX_MEMBER) ?
this.plugin.getIndexColumnName(this.qualifiedClassName) :
fieldName.equals(InstanceMapper.JDO_IDENTITY_MEMBER) ?
this.plugin.getIdentityColumnName(this.qualifiedClassName) :
this.plugin.getFieldColumnName(this.qualifiedClassName, fieldName);
}
//-----------------------------------------------------------------------
private String getPackagePrefix(
List qualifiedClassName
){
if(this.metaData == null) {
return null;
}
else {
int last = qualifiedClassName.size() - 1;
StringBuilder packageName = new StringBuilder();
for(String component : qualifiedClassName.subList(0, last)) {
packageName.append(
component
).append(
'.'
);
}
packageName.append(Names.JPA3_PACKAGE_SUFFIX);
PackageMetaData metaData = ((MetaData_2_0)this.metaData).getPackage(
packageName.toString()
);
return metaData == null ? null : metaData.getTablePrefix();
}
}
//-----------------------------------------------------------------------
/**
* Convert a model name to a database name
* @param qualifiedClassName
* @param modelName
*
* @return the table name
*/
private String getTableName(
List qualifiedClassName
) {
String tableName = this.plugin.getTableName(getPackagePrefix(qualifiedClassName), qualifiedClassName);
return this.sliceClassName == null ?
tableName :
this.plugin.getSliceTableName(tableName);
}
//-----------------------------------------------------------------------
private InheritanceStrategy getInheritanceStrategy(
) {
InheritanceStrategy thisStrategy = getInheritanceStrategy(this.classDef);
if(thisStrategy == null && !isBaseClass()) {
InheritanceStrategy superStrategy = getInheritanceStrategy(this.extendsClassDef);
if(superStrategy == InheritanceStrategy.TABLE_PER_CLASS) {
thisStrategy = InheritanceStrategy.JOINED;
}
}
return thisStrategy;
}
//-----------------------------------------------------------------------
protected static InheritanceStrategy getInheritanceStrategy(
ClassDef classDef
) {
ClassMetaData classMetaData = (ClassMetaData) classDef.getClassMetaData();
if(classMetaData != null) {
InheritanceMetaData inheritanceMetaData = classMetaData.getInheritance();
if(inheritanceMetaData != null){
return inheritanceMetaData.getStrategy();
}
}
return null;
}
//-----------------------------------------------------------------------
@Override
public void setProcess(
boolean process
) {
this.process = process;
}
//-----------------------------------------------------------------------
static final String DEFAULT_IDENTIFIER_MAPPING = "?";
private boolean process;
private final ByteArrayOutputStream streamBasicAttributes = new ByteArrayOutputStream();
private PrintWriter pwBasicAttributes;
private final ByteArrayOutputStream streamTransientAttributes = new ByteArrayOutputStream();
private PrintWriter pwTransientAttributes;
private final ByteArrayOutputStream streamOneToOneRelationships = new ByteArrayOutputStream();
private PrintWriter pwOneToOneRelationships;
private final ByteArrayOutputStream streamOneToManyRelationships = new ByteArrayOutputStream();
private PrintWriter pwOneToManyRelationships;
private final ByteArrayOutputStream streamManyToOneRelationships = new ByteArrayOutputStream();
private PrintWriter pwManyToOneRelationships;
private final ByteArrayOutputStream streamVersionAttributes = new ByteArrayOutputStream();
private PrintWriter pwVersionAttributes;
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy