GvNIXMapViewerMetadataProvider.java

/*
 * gvNIX is an open source tool for rapid application development (RAD).
 * Copyright (C) 2010 Generalitat Valenciana
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with
 * this program. If not, see <http://www.gnu.org/licenses/>.
 */
package org.gvnix.addon.geo.addon;

import java.util.ArrayList;
import java.util.List;
import java.util.logging.Logger;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Service;
import org.gvnix.addon.geo.annotations.GvNIXMapViewer;
import org.gvnix.support.WebProjectUtils;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.service.component.ComponentContext;
import org.springframework.roo.addon.propfiles.PropFileOperations;
import org.springframework.roo.classpath.PhysicalTypeIdentifier;
import org.springframework.roo.classpath.PhysicalTypeMetadata;
import org.springframework.roo.classpath.details.ClassOrInterfaceTypeDetails;
import org.springframework.roo.classpath.details.annotations.AnnotationAttributeValue;
import org.springframework.roo.classpath.details.annotations.AnnotationMetadata;
import org.springframework.roo.classpath.details.annotations.ArrayAttributeValue;
import org.springframework.roo.classpath.details.annotations.ClassAttributeValue;
import org.springframework.roo.classpath.itd.AbstractItdMetadataProvider;
import org.springframework.roo.classpath.itd.ItdTypeDetailsProvidingMetadataItem;
import org.springframework.roo.model.JavaSymbolName;
import org.springframework.roo.model.JavaType;
import org.springframework.roo.model.SpringJavaType;
import org.springframework.roo.project.LogicalPath;
import org.springframework.roo.project.ProjectOperations;
import org.springframework.roo.support.logging.HandlerUtils;

/**
 * Provides {@link GvNIXMapViewerMetadata}.
 * 
 * @author <a href="http://www.disid.com">DISID Corporation S.L.</a> made for <a
 *         href="http://www.dgti.gva.es">General Directorate for Information
 *         Technologies (DGTI)</a>
 * @since 1.4
 */
@Component
@Service
public final class GvNIXMapViewerMetadataProvider extends
        AbstractItdMetadataProvider {

    private static final Logger LOGGER = HandlerUtils
            .getLogger(GvNIXMapViewerMetadataProvider.class);

    private ProjectOperations projectOperations;

    private PropFileOperations propFileOperations;

    private WebProjectUtils webProjectUtils;

    /**
     * Register itself into metadataDependencyRegister and add metadata trigger
     * 
     * @param context the component context
     */
    protected void activate(ComponentContext cContext) {
        context = cContext.getBundleContext();
        getMetadataDependencyRegistry().registerDependency(
                PhysicalTypeIdentifier.getMetadataIdentiferType(),
                getProvidesType());
        addMetadataTrigger(new JavaType(GvNIXMapViewer.class.getName()));
    }

    /**
     * Unregister this provider
     * 
     * @param context the component context
     */
    protected void deactivate(ComponentContext context) {
        getMetadataDependencyRegistry().deregisterDependency(
                PhysicalTypeIdentifier.getMetadataIdentiferType(),
                getProvidesType());
        removeMetadataTrigger(new JavaType(GvNIXMapViewer.class.getName()));
    }

    /**
     * Return an instance of the Metadata offered by this add-on
     */
    protected ItdTypeDetailsProvidingMetadataItem getMetadata(
            String metadataIdentificationString, JavaType aspectName,
            PhysicalTypeMetadata governorPhysicalTypeMetadata,
            String itdFilename) {

        JavaType javaType = GvNIXMapViewerMetadata
                .getJavaType(metadataIdentificationString);

        ClassOrInterfaceTypeDetails controller = getTypeLocationService()
                .getTypeDetails(javaType);

        // Getting @RequestMapping annotation
        AnnotationMetadata requestMappingAnnotation = controller
                .getAnnotation(SpringJavaType.REQUEST_MAPPING);

        // Getting @GvNIXMapViewer annotation
        AnnotationMetadata mapViewerAnnotation = controller
                .getAnnotation(new JavaType(GvNIXMapViewer.class.getName()));

        // Getting path value
        AnnotationAttributeValue<Object> value = requestMappingAnnotation
                .getAttribute("value");

        String path = value.getValue().toString();

        // Getting mapId
        String mapId = String.format("ps_%s_%s", javaType.getPackage()
                .getFullyQualifiedPackageName().replaceAll("[.]", "_"),
                new JavaSymbolName(path.replaceAll("/", ""))
                        .getSymbolNameCapitalisedFirstLetter());

        // Getting entityLayers
        List<JavaType> entitiesToVisualize = new ArrayList<JavaType>();

        @SuppressWarnings({ "unchecked", "rawtypes" })
        ArrayAttributeValue<ClassAttributeValue> mapViewerAttributes = (ArrayAttributeValue) mapViewerAnnotation
                .getAttribute("entityLayers");
        if (mapViewerAttributes != null) {
            List<ClassAttributeValue> entityLayers = mapViewerAttributes
                    .getValue();
            for (ClassAttributeValue entity : entityLayers) {
                entitiesToVisualize.add(entity.getValue());
            }
        }

        // Getting projection
        String projection = "";
        AnnotationAttributeValue<Object> projectionAttr = mapViewerAnnotation
                .getAttribute("projection");
        if (projectionAttr != null) {
            projection = projectionAttr.getValue().toString();
        }

        return new GvNIXMapViewerMetadata(metadataIdentificationString,
                aspectName, governorPhysicalTypeMetadata,
                getProjectOperations(), getPropFileOperations(),
                getTypeLocationService(), getFileManager(),
                entitiesToVisualize, path, mapId, projection,
                getWebProjectUtils());
    }

    /**
     * Define the unique ITD file name extension, here the resulting file name
     * will be **_ROO_GvNIXMapViewer.aj
     */
    public String getItdUniquenessFilenameSuffix() {
        return "GvNIXMapViewer";
    }

    protected String getGovernorPhysicalTypeIdentifier(
            String metadataIdentificationString) {
        JavaType javaType = GvNIXMapViewerMetadata
                .getJavaType(metadataIdentificationString);
        LogicalPath path = GvNIXMapViewerMetadata
                .getPath(metadataIdentificationString);
        return PhysicalTypeIdentifier.createIdentifier(javaType, path);
    }

    protected String createLocalIdentifier(JavaType javaType, LogicalPath path) {
        return GvNIXMapViewerMetadata.createIdentifier(javaType, path);
    }

    public String getProvidesType() {
        return GvNIXMapViewerMetadata.getMetadataIdentiferType();
    }

    public ProjectOperations getProjectOperations() {
        if (projectOperations == null) {
            // Get all Services implement ProjectOperations interface
            try {
                ServiceReference<?>[] references = this.context
                        .getAllServiceReferences(
                                ProjectOperations.class.getName(), null);

                for (ServiceReference<?> ref : references) {
                    return (ProjectOperations) this.context.getService(ref);
                }

                return null;

            }
            catch (InvalidSyntaxException e) {
                LOGGER.warning("Cannot load ProjectOperations on GvNIXWebEntityMapLayerMetadataProvider.");
                return null;
            }
        }
        else {
            return projectOperations;
        }
    }

    public PropFileOperations getPropFileOperations() {
        if (propFileOperations == null) {
            // Get all Services implement PropFileOperations interface
            try {
                ServiceReference<?>[] references = this.context
                        .getAllServiceReferences(
                                PropFileOperations.class.getName(), null);

                for (ServiceReference<?> ref : references) {
                    return (PropFileOperations) this.context.getService(ref);
                }

                return null;

            }
            catch (InvalidSyntaxException e) {
                LOGGER.warning("Cannot load PropFileOperations on GvNIXWebEntityMapLayerMetadataProvider.");
                return null;
            }
        }
        else {
            return propFileOperations;
        }
    }

    public WebProjectUtils getWebProjectUtils() {
        if (webProjectUtils == null) {
            // Get all Services implement WebProjectUtils interface
            try {
                ServiceReference<?>[] references = this.context
                        .getAllServiceReferences(
                                WebProjectUtils.class.getName(), null);

                for (ServiceReference<?> ref : references) {
                    webProjectUtils = (WebProjectUtils) this.context
                            .getService(ref);
                    return webProjectUtils;
                }

                return null;

            }
            catch (InvalidSyntaxException e) {
                LOGGER.warning("Cannot load WebProjectUtils on GvNIXWebEntityMapLayerMetadataProvider.");
                return null;
            }
        }
        else {
            return webProjectUtils;
        }

    }

}