* Copyright (c) 2009 The JPA-XJC Project. All rights reserved.

*

* Redistribution and use in source and binary forms, with or without

* modification, are permitted provided that the following conditions

* are met:

*

*   o Redistributions of source code must retain the above copyright

*     notice, this  list of conditions and the following disclaimer.

*

*   o 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.

*

* THIS SOFTWARE IS PROVIDED BY THE JPA-XJC PROJECT 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 JPA-XJC PROJECT 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.

*

* $Id$

*

*/

* JPA-XJC plugin implementation.

*

* @author <a href="mailto:cs@schulte.it">Christian Schulte</a>

* @version $Id$

*/

    // This class was written in about 2 hours. Don't expect any beauties!

    /** ORM version the plugin supports. */

    private static final String ORM_VERSION = "1.0";

    /** Persistence version the plugin supports. */

    private static final String PERSISTENCE_VERSION = "1.0";

    /** {@code http://java.sun.com/xml/ns/persistence} namespace URI. */

    private static final String PERSISTENCE_NS = "http://java.sun.com/xml/ns/persistence";

    /** Default {@code http://java.sun.com/xml/ns/persistence} schema system id. */

    private static final String DEFAULT_PERSISTENCE_SYSTEM_ID =

        "http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd";

    /** {@code http://java.sun.com/xml/ns/persistence} classpath location. */

    private static final String PERSISTENCE_SCHEMA_CLASSPATH_LOCATION =

        "/net/sourceforge/jpaxjc/ns/persistence/persistence_1_0.xsd";

    /** {@code http://java.sun.com/xml/ns/persistence/orm} namespace URI. */

    private static final String ORM_NS = "http://java.sun.com/xml/ns/persistence/orm";

    /** Default {@code http://java.sun.com/xml/ns/persistence/orm} schema system id. */

    private static final String DEFAULT_ORM_SYSTEM_ID = "http://java.sun.com/xml/ns/persistence/orm_1_0.xsd";

    /** {@code http://java.sun.com/xml/ns/persistence/orm} classpath location. */

    private static final String ORM_SCHEMA_CLASSPATH_LOCATION =

        "/net/sourceforge/jpaxjc/ns/persistence/orm/orm_1_0.xsd";

    /** Prefix added to messages logged to the console. */

    private static final String MESSAGE_PREFIX = "JPA-XJC";

    /** Constant for the {@code -jpa} option. */

    private static final String JPA_OPTION_NAME = "-jpa";

    /** Constant for the {@code -persistenceSystemId} option. */

    private static final String PERSISTENCE_SYSTEM_ID_OPTION_NAME = "-persistenceSystemId";

    /** Constant for the {@code -ormSystemId} option. */

    private static final String ORM_SYSTEM_ID_OPTION_NAME = "-ormSystemId";

    /** The persistence unit name of the generated unit. */

    private String persistenceUnitName;

    /** The persistence unit root of the generated unit. */

    private File persistenceUnitRoot;

    /** Options passed to the plugin. */

    private Options options;

    /** {@code http://java.sun.com/xml/ns/persistence} schema system id. */

    private String persistenceSystemId = DEFAULT_PERSISTENCE_SYSTEM_ID;

    /** {@code http://java.sun.com/xml/ns/persistence/orm} schema system id. */

    private String ormSystemId = DEFAULT_ORM_SYSTEM_ID;

    /** Set of mapped classes. */

    private final Set<String> mappedClasses = new HashSet<String>();

    /** Empty JType array. */

    private static final JType[] NO_JTYPES =

    {

    };

    // --

    // Plugin methods.

    // --

    @Override

    public String getOptionName()

    {

        return "jpa";

    }

    @Override

    public int parseArgument( final Options opt, final String[] args, int i )

        throws BadCommandLineException, IOException

    {

        if ( JPA_OPTION_NAME.equals( args[i] ) )

        {

            this.persistenceUnitName = opt.requireArgument( JPA_OPTION_NAME, args, ++i );

            this.persistenceUnitRoot = new File( opt.requireArgument( JPA_OPTION_NAME, args, ++i ) );

            return 3;

        }

        if ( PERSISTENCE_SYSTEM_ID_OPTION_NAME.equals( args[i] ) )

        {

            this.persistenceSystemId = opt.requireArgument( PERSISTENCE_SYSTEM_ID_OPTION_NAME, args, ++i );

            return 2;

        }

        if ( ORM_SYSTEM_ID_OPTION_NAME.equals( args[i] ) )

        {

            this.ormSystemId = opt.requireArgument( ORM_SYSTEM_ID_OPTION_NAME, args, ++i );

            return 2;

        }

        return 0;

    }

    @Override

    public String getUsage()

    {

        final String lineSeparator = System.getProperty( "line.separator" );

        final StringBuilder b = new StringBuilder();

        b.append( "  -jpa               :  " ).append( getMessage( "usage" ) ).append( lineSeparator );

        b.append( "                     :  " ).append( getMessage( "usageUnitName" ) ).append( lineSeparator );

        b.append( "                     :  " ).append( getMessage( "usageUnitRoot" ) ).append( lineSeparator );

        b.append( "                     :  " ).append( getMessage( "jpaSystemId", this.persistenceSystemId ) ).

            append( lineSeparator );

        b.append( "                     :  " ).append( getMessage( "ormSystemId", this.ormSystemId ) );

        return b.toString();

    }

    @Override

    public List<String> getCustomizationURIs()

    {

        return Arrays.asList( new String[]

            {

                ORM_NS, PERSISTENCE_NS

            } );

    }

    @Override

    public boolean isCustomizationTagName( final String nsUri, final String localName )

    {

        return nsUri.equals( ORM_NS ) || nsUri.equals( PERSISTENCE_NS );

    }

    @Override

    public boolean run( final Outline model, final Options options, final ErrorHandler errorHandler )

        throws SAXException

    {

        boolean success = true;

        this.options = options;

        this.log( Level.INFO, "title" );

        try

        {

            final EntityMappings orm = new EntityMappings();

            orm.setVersion( ORM_VERSION );

            this.mappedClasses.clear();

            for ( ClassOutline c : model.getClasses() )

            {

                this.toMappedSuperclass( model, c, orm );

            }

            for ( ClassOutline c : model.getClasses() )

            {

                this.toEmbeddable( c, orm );

            }

            for ( ClassOutline c : model.getClasses() )

            {

                this.toEntity( model, c, orm );

            }

            this.customizeOrm( model.getModel().getCustomizations(), orm );

            for ( PackageOutline p : model.getAllPackageContexts() )

            {

                this.generateAdapterMethods( model.getCodeModel(), p );

            }

            for ( Entity e : orm.getEntity() )

            {

                if ( e.getAttributes() == null )

                {

                    e.setAttributes( new Attributes() );

                }

                this.addMandatoryAttributes( orm, e.getAttributes(), this.getClassOutline( model, e.getClazz() ) );

            }

            final Persistence p = new Persistence();

            final Persistence.PersistenceUnit u = new Persistence.PersistenceUnit();

            u.setName( this.persistenceUnitName );

            p.setVersion( PERSISTENCE_VERSION );

            p.getPersistenceUnit().add( u );

            this.customizePersistenceUnit( model.getModel().getCustomizations(), u );

            for ( Entity e : orm.getEntity() )

            {

                if ( !u.getClazz().contains( e.getClazz() ) )

                {

                    u.getClazz().add( e.getClazz() );

                }

            }

            for ( Embeddable e : orm.getEmbeddable() )

            {

                if ( !u.getClazz().contains( e.getClazz() ) )

                {

                    u.getClazz().add( e.getClazz() );

                }

            }

            for ( MappedSuperclass m : orm.getMappedSuperclass() )

            {

                if ( !u.getClazz().contains( m.getClazz() ) )

                {

                    u.getClazz().add( m.getClazz() );

                }

            }

            this.annotate( model, orm );

            orm.getEmbeddable().clear();

            orm.getEntity().clear();

            orm.getMappedSuperclass().clear();

            final SchemaFactory schemaFactory = SchemaFactory.newInstance( XMLConstants.W3C_XML_SCHEMA_NS_URI );

            final Schema persistenceSchema =

                schemaFactory.newSchema( this.getClass().getResource( PERSISTENCE_SCHEMA_CLASSPATH_LOCATION ) );

            final Schema ormSchema =

                schemaFactory.newSchema( this.getClass().getResource( ORM_SCHEMA_CLASSPATH_LOCATION ) );

            final JAXBContext persistenceCtx = JAXBContext.newInstance( "net.sourceforge.jpaxjc.ns.persistence" );

            final JAXBContext ormCtx = JAXBContext.newInstance( "net.sourceforge.jpaxjc.ns.persistence.orm" );

            final Marshaller persistenceMarshaller = persistenceCtx.createMarshaller();

            final Marshaller ormMarshaller = ormCtx.createMarshaller();

            persistenceMarshaller.setSchema( persistenceSchema );

            persistenceMarshaller.setProperty( Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE );

            persistenceMarshaller.setProperty( Marshaller.JAXB_SCHEMA_LOCATION,

                                               PERSISTENCE_NS + ' ' + this.persistenceSystemId );

            ormMarshaller.setSchema( ormSchema );

            ormMarshaller.setProperty( Marshaller.JAXB_FORMATTED_OUTPUT, Boolean.TRUE );

            ormMarshaller.setProperty( Marshaller.JAXB_SCHEMA_LOCATION, ORM_NS + ' ' + this.ormSystemId );

            final File metaInf = new File( this.persistenceUnitRoot, "META-INF" );

            if ( !metaInf.exists() )

            {

                success = metaInf.mkdirs();

            }

            if ( orm.getAccess() != null

                 || orm.getCatalog() != null

                 || orm.getDescription() != null

                 || !orm.getNamedNativeQuery().isEmpty()

                 || !orm.getNamedQuery().isEmpty()

                 || orm.getPackage() != null

                 || orm.getPersistenceUnitMetadata() != null

                 || orm.getSchema() != null

                 || !orm.getSequenceGenerator().isEmpty()

                 || !orm.getSqlResultSetMapping().isEmpty()

                 || !orm.getTableGenerator().isEmpty()

                 || !orm.getEmbeddable().isEmpty()

                 || !orm.getEntity().isEmpty()

                 || !orm.getMappedSuperclass().isEmpty() )

            {

                final File ormFile = new File( metaInf, this.persistenceUnitName + ".xml" );

                this.log( Level.INFO, "writing", ormFile.getAbsolutePath() );

                ormMarshaller.marshal( orm, ormFile );

                u.getMappingFile().add( "META-INF/" + this.persistenceUnitName + ".xml" );

            }

            final File persistenceFile = new File( metaInf, "persistence.xml" );

            this.log( Level.INFO, "writing", persistenceFile.getAbsolutePath() );

            persistenceMarshaller.marshal( p, persistenceFile );

        }

        catch ( JAXBException e )

        {

            errorHandler.fatalError( new SAXParseException( e.getMessage(), null, e ) );

            success = false;

        }

        return success;

    }

    // ---

    // Mapping methods.

    // ---

    private void toMappedSuperclass( final Outline outline, final ClassOutline c, final EntityMappings orm )