org.openmdx.application.mof.mapping.java.ClassMapper Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmdx-dalvik Show documentation
openMDX/Dalvik Library
There is a newer version: 2.18.10
/*
 * ==================================================================== 
 * Project:      openmdx, http://www.openmdx.org
 * Description:  JMIClassLevelTemplate  
 * 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.Writer;
import java.util.List;

import org.openmdx.application.mof.mapping.cci.ClassDef;
import org.openmdx.application.mof.mapping.cci.MetaData_1_0;
import org.openmdx.application.mof.mapping.spi.MapperUtils;
import org.openmdx.base.exception.ServiceException;
import org.openmdx.base.mof.cci.ModelElement_1_0;
import org.openmdx.base.mof.cci.Model_1_0;

/**
 * ClassMapper
 */
@SuppressWarnings({"rawtypes"})
public class ClassMapper extends AbstractClassMapper {

    public ClassMapper(
        ModelElement_1_0 classDef,        
        Writer writer, 
        Model_1_0 model,
        Format format, 
        String packageSuffix,
        MetaData_1_0 metaData, 
        PrimitiveTypeMapper primitiveTypeMapper
    ) throws ServiceException {
        super(
            classDef,
            writer, 
            model,
            format, 
            packageSuffix, 
            metaData, 
            primitiveTypeMapper
        );
    }
    
    //-----------------------------------------------------------------------
    public void mapInstanceExtenderRequiredAttributes(
        ClassDef superclassDef,
        List requiredAttributes
    ) throws ServiceException {
        // Nothing to do
    }

    //-----------------------------------------------------------------------
    public void mapIntfInstanceExtenderAllAttributes(
        ClassDef superclassDef,
        List attributes
    ) throws ServiceException {
        // Nothing to do
    }

    //-----------------------------------------------------------------------
    public void mapInstanceCreatorRequiredAttributes(
        List requiredAttributes
    ) throws ServiceException {
        // Nothing to do
    }

    //-----------------------------------------------------------------------
    public void mapIntfInstanceCreatorAllAttributes(
        List attributes
    ) throws ServiceException {
        // Nothing to do
    }

    //-----------------------------------------------------------------------
    public void mapEnd() {
        this.trace("ClassProxy/End.vm");
        this.pw.println("}");
    }

    //-----------------------------------------------------------------------
    public void mapBegin(
    ) {
        this.trace("ClassProxy/Begin");
        this.fileHeader();
        this.pw.println("package " + this.getNamespace(MapperUtils.getNameComponents(MapperUtils.getPackageName(this.classDef.getQualifiedName()))) + ";");
        this.pw.println("");
        this.pw.println("public interface " + this.className + "Class ");
        if(getFormat() == Format.JMI1) this.pw.println("  extends javax.jmi.reflect.RefClass");
        this.pw.println("{");
        this.pw.println("");
        this.pw.println("  /**");
        this.pw.println(
            MapperUtils.wrapText(
                "   * ",
                "Creates an instance of class " + this.className + "."
            )
        );
        this.pw.println(
            MapperUtils.wrapText(
                "   * ",
                "This is a factory operation used to create instance objects of class " + this.className + "."
            )
        );
        this.pw.println("   */");
        this.pw.println("  public " + this.className + " create" + this.className + "(");
        this.pw.println("  );");
        this.pw.println("");
        this.pw.println("  /**");
        this.pw.println(
            MapperUtils.wrapText(
                "   * ",
                "Creates an instance of class " + this.className + " based on the specified Object instance."
            )
        );
        this.pw.println(
            MapperUtils.wrapText(
                "   * ",
                "This is a factory operation used to create instance objects of class " + this.className + "."
            )
        );
        this.pw.println(
            MapperUtils.wrapText(
                "   * ",
                "@param object The Object instance this class is based on."
            )
        );
        this.pw.println("   */");
        this.pw.println("  public " + this.className + " get" + this.className + "(");
        this.pw.println("    Object object");
        this.pw.println("  );");
    }

}