lightning-core/src/main/java/org/apache/directmemory/lightning/internal/InternalSerializerCreator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apache.directmemory.lightning.internal;

import java.io.File;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Set;
import java.util.Stack;

import org.apache.directmemory.lightning.ClassComparisonStrategy;
import org.apache.directmemory.lightning.Marshaller;
import org.apache.directmemory.lightning.MarshallerStrategy;
import org.apache.directmemory.lightning.SerializationStrategy;
import org.apache.directmemory.lightning.Serializer;
import org.apache.directmemory.lightning.configuration.SerializerDefinition;
import org.apache.directmemory.lightning.generator.DefinitionBuildingContext;
import org.apache.directmemory.lightning.generator.DefinitionVisitor;
import org.apache.directmemory.lightning.generator.PropertyDescriptorFactory;
import org.apache.directmemory.lightning.instantiator.ObjectInstantiatorFactory;
import org.apache.directmemory.lightning.internal.beans.InternalPropertyDescriptorFactory;
import org.apache.directmemory.lightning.internal.instantiator.ObjenesisSerializer;
import org.apache.directmemory.lightning.internal.util.ClassUtil;
import org.apache.directmemory.lightning.internal.util.TypeUtil;
import org.apache.directmemory.lightning.logging.Logger;
import org.apache.directmemory.lightning.logging.NoOpLogger;
import org.apache.directmemory.lightning.metadata.Attribute;
import org.apache.directmemory.lightning.metadata.ClassDefinition;
import org.apache.directmemory.lightning.metadata.ClassDescriptor;
import org.apache.directmemory.lightning.metadata.PropertyDescriptor;
import org.apache.directmemory.lightning.metadata.ValueNullableEvaluator;

public final class InternalSerializerCreator
{

    private final Map<Class<?>, InternalClassDescriptor> classDescriptors =
        new HashMap<Class<?>, InternalClassDescriptor>();

    private final List<SerializerDefinition> serializerDefinitions = new ArrayList<SerializerDefinition>();

    private final Map<Class<?>, Marshaller> marshallers = new HashMap<Class<?>, Marshaller>();

    private final ObjectInstantiatorFactory objectInstantiatorFactory = new ObjenesisSerializer( true );

    private ValueNullableEvaluator valueNullableEvaluator;

    private SerializationStrategy serializationStrategy = SerializationStrategy.SpeedOptimized;

    private Class<? extends Annotation> attributeAnnotation = Attribute.class;

    private ClassComparisonStrategy classComparisonStrategy = ClassComparisonStrategy.LightningChecksum;

    private File debugCacheDirectory = null;

    private Logger logger = new NoOpLogger();

    public InternalSerializerCreator()
    {
    }

    public InternalSerializerCreator addSerializerDefinitions( Iterable<? extends SerializerDefinition> serializerDefinitions )
    {
        for ( SerializerDefinition serializerDefinition : serializerDefinitions )
        {
            this.serializerDefinitions.add( serializerDefinition );
        }

        return this;
    }

    public InternalSerializerCreator setDebugCacheDirectory( File debugCacheDirectory )
    {
        this.debugCacheDirectory = debugCacheDirectory;
        return this;
    }

    public InternalSerializerCreator setLogger( Logger logger )
    {
        this.logger = logger;
        return this;
    }

    public InternalSerializerCreator setAttributeAnnotation( Class<? extends Annotation> attributeAnnotation )
    {
        this.attributeAnnotation = attributeAnnotation;
        return this;
    }

    public InternalSerializerCreator setSerializationStrategy( SerializationStrategy serializationStrategy )
    {
        this.serializationStrategy = serializationStrategy;
        return this;
    }

    public InternalSerializerCreator setClassComparisonStrategy( ClassComparisonStrategy classComparisonStrategy )
    {
        this.classComparisonStrategy = classComparisonStrategy;
        return this;
    }

    public InternalSerializerCreator setValueNullableEvaluator( ValueNullableEvaluator valueNullableEvaluator )
    {
        this.valueNullableEvaluator = valueNullableEvaluator;
        return this;
    }

    public Serializer build()
    {
        PropertyDescriptorFactory propertyDescriptorFactory = new InternalPropertyDescriptorFactory( logger );
        MarshallerStrategy marshallerStrategy = new InternalMarshallerStrategy();
        DefinitionBuildingContext definitionBuildingContext =
            new InternalDefinitionBuildingContext( marshallerStrategy, propertyDescriptorFactory );

        DefinitionVisitor definitionVisitor = new InternalDefinitionVisitor();
        for ( SerializerDefinition serializerDefinition : serializerDefinitions )
        {
            serializerDefinition.configure( definitionBuildingContext, objectInstantiatorFactory );
            serializerDefinition.acceptVisitor( definitionVisitor );
        }

        Set<ClassDefinition> classDefinitions =
            new HashSet<ClassDefinition>( Arrays.asList( ClassUtil.CLASS_DESCRIPTORS ) );
        for ( InternalClassDescriptor classDescriptor : classDescriptors.values() )
        {
            classDefinitions.add( classDescriptor.build( ClassUtil.CLASS_DESCRIPTORS ).getClassDefinition() );
        }

        Map<Class<?>, ClassDescriptor> cleanedClassDescriptors =
            new HashMap<Class<?>, ClassDescriptor>( classDescriptors.size() );
        for ( Entry<Class<?>, InternalClassDescriptor> entry : classDescriptors.entrySet() )
        {
            cleanedClassDescriptors.put( entry.getKey(), entry.getValue() );
        }

        return new InternalSerializer( new InternalClassDefinitionContainer( classDefinitions ), serializationStrategy,
                                       classComparisonStrategy, cleanedClassDescriptors, marshallers,
                                       objectInstantiatorFactory, logger, marshallerStrategy, debugCacheDirectory,
                                       valueNullableEvaluator );
    }

    private InternalClassDescriptor findClassDescriptor( Class<?> type )
    {
        InternalClassDescriptor classDescriptor = classDescriptors.get( type );
        if ( classDescriptor == null )
        {
            classDescriptor = new InternalClassDescriptor( type, logger );
            classDescriptors.put( type, classDescriptor );
        }

        return classDescriptor;
    }

    private class InternalDefinitionVisitor
        implements DefinitionVisitor
    {

        private final Stack<Class<? extends Annotation>> attributeAnnotation = new Stack<Class<? extends Annotation>>();

        @Override
        public void visitSerializerDefinition( SerializerDefinition serializerDefinition )
        {
            // If at top level definition just add the base annotation
            if ( attributeAnnotation.size() == 0 )
            {
                if ( InternalSerializerCreator.this.attributeAnnotation == null )
                {
                    attributeAnnotation.push( Attribute.class );
                }
                else
                {
                    attributeAnnotation.push( InternalSerializerCreator.this.attributeAnnotation );
                }
            }
            else
            {
                Class<? extends Annotation> annotation = attributeAnnotation.peek();
                attributeAnnotation.push( annotation );
            }
        }

        @Override
        public void visitAttributeAnnotation( Class<? extends Annotation> attributeAnnotation )
        {
            // Remove last element and replace it with the real annotation to
            // use right from that moment
            this.attributeAnnotation.pop();
            this.attributeAnnotation.push( attributeAnnotation );
        }

        @Override
        public void visitClassDefine( Type type, Marshaller marshaller )
        {
            Class<?> rawType = TypeUtil.getBaseType( type );
            InternalClassDescriptor classDescriptor = findClassDescriptor( rawType );
            classDescriptor.setMarshaller( marshaller );

            marshallers.put( rawType, marshaller );
        }

        @Override
        public void visitAnnotatedAttribute( PropertyDescriptor propertyDescriptor, Marshaller marshaller )
        {
            InternalClassDescriptor classDescriptor = findClassDescriptor( propertyDescriptor.getDefinedClass() );

            if ( logger.isTraceEnabled() )
            {
                logger.trace( "Found property " + propertyDescriptor.getName() + " ("
                    + propertyDescriptor.getInternalSignature() + ") on type "
                    + propertyDescriptor.getDefinedClass().getCanonicalName() );
            }

            classDescriptor.push( propertyDescriptor );
        }

        @Override
        public void visitPropertyDescriptor( PropertyDescriptor propertyDescriptor, Marshaller marshaller )
        {
            InternalClassDescriptor classDescriptor = findClassDescriptor( propertyDescriptor.getDefinedClass() );

            if ( logger.isTraceEnabled() )
            {
                logger.trace( "Found property " + propertyDescriptor.getName() + " ("
                    + propertyDescriptor.getInternalSignature() + ") on type "
                    + propertyDescriptor.getDefinedClass().getCanonicalName() );
            }

            classDescriptor.push( propertyDescriptor );
        }

        @Override
        public void visitFinalizeSerializerDefinition( SerializerDefinition serializerDefinition )
        {
            // Clean this level up
            this.attributeAnnotation.pop();
        }
    }
}