/*
    * 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.projectdoc;
  
  import java.util.Locale;
  
  import org.jdom.Document;
  import org.jdom.Element;
  import org.jdom.Namespace;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  
  import de.smartics.properties.api.core.domain.PropertiesContext;
  import de.smartics.properties.api.core.domain.PropertyDescriptor;
  import de.smartics.properties.api.core.domain.PropertySetProjectdoc;
  import de.smartics.properties.spi.core.metadata.projectdoc.ProjectdocAnnotationCollector.Defaults;
  
  /**
   * Parsed projectdoc's property set documents.
   */
  public final class PropertySetProjectdocParser extends ProjectdocMetaDataParser
  {
    // ********************************* Fields *********************************
  
    // --- constants ------------------------------------------------------------
  
    /**
     * Reference to the logger for this class.
     */
    private static final Logger LOG = LoggerFactory
        .getLogger(PropertySetProjectdocParser.class);
  
    /**
     * The namespace of the XML files this parser can parse.
     */
    protected static final Namespace NS =
        Namespace
            .getNamespace("http://www.smartics.de/schema/projectdoc/doctype/property-set/1");
  
    // --- members --------------------------------------------------------------
  
    // ****************************** Initializer *******************************
  
    // ****************************** Constructors ******************************
  
    /**
     * Convenience constructor without defaults.
     *
     * @param context the properties context to fetch information from the
     *          META-INF folder.
     * @throws NullPointerException if {@code context} is <code>null</code>.
     */
    public PropertySetProjectdocParser(final PropertiesContext context)
      throws NullPointerException
    {
      super(context);
    }
  
    /**
     * Default constructor.
     *
     * @param context the properties context to fetch information from the
     *          META-INF folder.
     * @param defaults the metadata defaults to use.
     * @throws NullPointerException if {@code context} is <code>null</code>.
     */
    public PropertySetProjectdocParser(final PropertiesContext context,
        final Defaults defaults) throws NullPointerException
    {
      super(context, defaults);
    }
  
    // ****************************** Inner Classes *****************************
  
    // ********************************* Methods ********************************
  
    // --- init -----------------------------------------------------------------
  
    // --- get&set --------------------------------------------------------------
  
    // --- business -------------------------------------------------------------
  
    @Override
    protected String calcPath(final PropertyDescriptor descriptor,
        final Locale locale)
    {
     return context.createMetaInfPathPropertySet(descriptor, locale);
   }
 
   @Override
   public PropertySetProjectdoc parse(final PropertyDescriptor descriptor,
       final Locale locale)
   {
     try
     {
       final PropertySetProjectdoc projectdoc = new PropertySetProjectdoc();
       parseBase(descriptor, locale, projectdoc);
       return projectdoc;
     }
     catch (final MetaDataException e)
     {
       LOG.warn("Cannot parse property set document for property '{}': {}",
           descriptor, e);
       return null;
     }
   }
 
   @Override
   protected void parseAdditional(final ParserContext context)
   {
     final PropertySetProjectdoc projectdoc =
         (PropertySetProjectdoc) context.getMetaData();
 
     addPropertySetComment(projectdoc, context);
   }
 
   private void addPropertySetComment(final PropertySetProjectdoc projectdoc,
       final ParserContext context)
   {
     final Document document = context.getDocument();
     final Element rootNode = document.getRootElement();
 
     final String specification =
         rootNode.getChildTextNormalize("specification", NS);
 
     projectdoc.setComment(specification);
   }
 
   @Override
   protected Namespace getNs()
   {
     return NS;
   }
 
   // --- object basics --------------------------------------------------------
 
 }