org.codehaus.modello.plugins.xml.metadata.XmlMetadataPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of modello-plugin-xml Show documentation
Modello XML Plugin contains shared code for every plugins working on XML representation of the model.
The newest version!
package org.codehaus.modello.plugins.xml.metadata;

/*
 * Copyright (c) 2004, Codehaus.org
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

import javax.inject.Named;
import javax.inject.Singleton;

import java.util.Map;

import org.codehaus.modello.metadata.AbstractMetadataPlugin;
import org.codehaus.modello.metadata.AssociationMetadata;
import org.codehaus.modello.metadata.ClassMetadata;
import org.codehaus.modello.metadata.FieldMetadata;
import org.codehaus.modello.metadata.InterfaceMetadata;
import org.codehaus.modello.metadata.MetadataPlugin;
import org.codehaus.modello.metadata.ModelMetadata;
import org.codehaus.modello.model.Model;
import org.codehaus.modello.model.ModelAssociation;
import org.codehaus.modello.model.ModelClass;
import org.codehaus.modello.model.ModelField;
import org.codehaus.modello.model.ModelInterface;

/**
 * @author Trygve Laugstøl
 * @author Emmanuel Venisse
 */
@Named("xml")
@Singleton
public class XmlMetadataPlugin extends AbstractMetadataPlugin implements MetadataPlugin {
    public static final String XML_ATTRIBUTE = "xml.attribute";

    public static final String XML_CONTENT = "xml.content";

    public static final String XML_FORMAT = "xml.format";

    public static final String XML_ITEMS_STYLE = "xml.itemsStyle";

    public static final String XML_MAP_STYLE = "xml.mapStyle";

    public static final String XML_NAMESPACE = "xml.namespace";

    public static final String XML_REFERENCE = "xml.reference";

    public static final String XML_SCHEMA_LOCATION = "xml.schemaLocation";

    public static final String XML_TAG_NAME = "xml.tagName";

    public static final String XML_STANDALONE_READ = "xml.standaloneRead";

    public static final String XML_TRIM = "xml.trim";

    public static final String XML_TRANSIENT = "xml.transient";

    public static final String XML_INSERT_PARENT_FIELDS_UP_TO = "xml.insertParentFieldsUpTo";

    // ----------------------------------------------------------------------
    // Map to Metadata
    // ----------------------------------------------------------------------

    public ModelMetadata getModelMetadata(Model model, Map data) {
        XmlModelMetadata metadata = new XmlModelMetadata();

        metadata.setNamespace(getString(data, XML_NAMESPACE));

        metadata.setSchemaLocation(getString(data, XML_SCHEMA_LOCATION));

        return metadata;
    }

    public ClassMetadata getClassMetadata(ModelClass clazz, Map data) {
        XmlClassMetadata metadata = new XmlClassMetadata();

        metadata.setTagName(getString(data, XML_TAG_NAME));

        metadata.setStandaloneRead(getBoolean(data, XML_STANDALONE_READ, false));

        return metadata;
    }

    public InterfaceMetadata getInterfaceMetadata(ModelInterface iface, Map data) {
        return new XmlInterfaceMetadata();
    }

    public FieldMetadata getFieldMetadata(ModelField field, Map data) {
        XmlFieldMetadata metadata = new XmlFieldMetadata();

        metadata.setAttribute(getBoolean(data, XML_ATTRIBUTE, false));

        metadata.setContent(getBoolean(data, XML_CONTENT, false));

        metadata.setTrim(getBoolean(data, XML_TRIM, true));

        metadata.setTagName(getString(data, XML_TAG_NAME));

        metadata.setFormat(getString(data, XML_FORMAT));

        metadata.setTransient(getBoolean(data, XML_TRANSIENT, false));

        metadata.setInsertParentFieldsUpTo(getString(data, XML_INSERT_PARENT_FIELDS_UP_TO));

        return metadata;
    }

    public AssociationMetadata getAssociationMetadata(ModelAssociation association, Map data) {
        XmlAssociationMetadata metadata = new XmlAssociationMetadata();

        metadata.setTagName(getString(data, XML_TAG_NAME));

        metadata.setItemsStyle(getString(data, XML_ITEMS_STYLE));

        metadata.setMapStyle(getString(data, XML_MAP_STYLE));

        metadata.setReference(getBoolean(data, XML_REFERENCE, false));

        return metadata;
    }
}