/*

  * Copyright 2012-2013 smartics, Kronseder & Reiner GmbH

  *

  * Licensed 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 de.smartics.properties.spi.core.metadata;

 import java.lang.reflect.Method;

 import java.util.HashMap;

 import java.util.Locale;

 import java.util.Map;

 import org.apache.commons.lang.builder.ToStringBuilder;

 import de.smartics.properties.api.core.domain.DocumentMetaData;

 import de.smartics.properties.api.core.domain.PropertiesContext;

 import de.smartics.properties.api.core.domain.PropertyDescriptor;

 import de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocAnnotationCollector;

 import de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocAnnotationCollector.Defaults;

 import de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocMetaDataParser;

 import de.smartics.properties.spi.core.util.SerializableMethod;

 /**

  * Allows to lazy load annotation information.

  */

 public final class MetaInfDocumentMetaDataProxy implements

     DocumentMetaDataProxy

 {

   // ********************************* Fields *********************************

   // --- constants ------------------------------------------------------------

   /**

    * The class version identifier.

    */

   private static final long serialVersionUID = 1L;

   // --- members --------------------------------------------------------------

   /**

    * The properties context to fetch information from the META-INF folder. May

    * be <code>null</code>.

    *

    * @serial

    */

   private final PropertiesContext context;

   /**

    * The method to use to fetch annotations in case the context is not to be

    * used.

    *

    * @serial

    */

   private final SerializableMethod propertyMethod;

   /**

    * The cached comments.

    *

    * @serial

    */

   private final Map<Locale, DocumentMetaData> metaData =

       new HashMap<Locale, DocumentMetaData>();

   // ****************************** Initializer *******************************

   // ****************************** Constructors ******************************

   /**

    * Default constructor.

    *

    * @param context the properties context to fetch information from the

    *          <code>META-INF</code> folder.

    * @param propertyMethod the method to use to fetch annotations in case the

    *          context is not to be used.

    */

   public MetaInfDocumentMetaDataProxy(final PropertiesContext context,

       final Method propertyMethod)

   {

     this.context = context;

     this.propertyMethod = new SerializableMethod(propertyMethod);

   }

   // ****************************** Inner Classes *****************************

   // ********************************* Methods ********************************

   // --- init -----------------------------------------------------------------

   // --- get&set --------------------------------------------------------------

   // --- business -------------------------------------------------------------

   /**

    * Returns the document meta data.

    *

    * @param descriptor the descriptor of the property whose document meta data

    *          is requested.

    * @param locale the locale to select the meta data in a specific language.

    * @return the document meta data written for the given locale.

    */

   @Override

   public DocumentMetaData getDocumentMetaData(

       final PropertyDescriptor descriptor, final Locale locale)

   {

     DocumentMetaData metaData = this.metaData.get(locale);

     if (metaData == null)

     {

       final Method propertyMethod = this.propertyMethod.getMethod();

       if (propertyMethod == null)

       {

         throw new IllegalStateException(

             "Cannot find documentation for method value 'null'.");

       }

       final Class<?> declaringType = propertyMethod.getDeclaringClass();

       if (context != null)

       {

         final Defaults defaults = new PropertyMetaDataDefaults(propertyMethod);

         final ProjectdocMetaDataParser parser =

             new ProjectdocMetaDataParser(context, defaults);

         metaData = parser.parse(descriptor, locale);

       }

       if (metaData == null)

       {

         final Defaults defaults =

             new PropertyMetaDataDefaults(declaringType, propertyMethod);

         final ProjectdocAnnotationCollector collector =

             new ProjectdocAnnotationCollector(declaringType, defaults);

         metaData = collector.createMetaDataFromAnnotations(propertyMethod);

         this.metaData.put(locale, metaData);

       }

     }

     return metaData;

   }

   // --- object basics --------------------------------------------------------

   /**

    * Returns the string representation of the object.

    *

    * @return the string representation of the object.

    */

   @Override

   public String toString()

   {

     return ToStringBuilder.reflectionToString(this);

   }

 }