/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

package ifc.text;

import java.util.HashMap;
import java.util.Iterator;

import lib.StatusException;
import lib.TestParameters;
import share.LogWriter;

import com.sun.star.beans.PropertyValue;


/**
* Testing <code>com.sun.star.text.NumberingLevel</code><p>
* This service is currently known as property value of
* com.sun.star.text.ParagraphProperties.NumberingRules
* This test checks only for completnes of implemented properties.
* service properties :
* <ul>
*  <li><code> Adjust</code></li>
*  <li><code> ParentNumbering</code></li>
*  <li><code> Prefix</code></li>
*  <li><code> Suffix</code></li>
*  <li><code> CharStyleName</code></li>
*  <li><code> BulletId</code></li>
*  <li><code> BulletChar</code></li>
*  <li><code> BulletFontName</code></li>
*  <li><code> BulletFont</code></li>
*  <li><code> GraphicURL</code></li>
*  <li><code> GraphicBitmap</code></li>
*  <li><code> GraphicSize</code></li>
*  <li><code> VertOrient</code></li>
*  <li><code> StartWith</code></li>
*  <li><code> LeftMargin</code></li>
*  <li><code> SymbolTextDistance</code></li>
*  <li><code> FirstLineOffset</code></li>
*  <li><code> NumberingType</code></li>
*  <li><code> HeadingStyleName</code></li>
*  <li><code> BulletColor</code></li>
*  <li><code> BulletRelSize</code></li>
* </ul> <p>
*
* @see com.sun.star.text.NumberingLevel
* @see com.sun.star.test.ParagraphProperties
* @see ifc.style._ParagraphProperties
*/
public class _NumberingLevel {

    private HashMap<String, Boolean> NumberingLevel = new HashMap<String,Boolean>();
    private PropertyValue[] PropertyArray = null;
    private LogWriter log = null;


    /**
     * returns an instance of _NumberingLevel
     * @param log the log writer
     * @param tParam the test parameters
     * @param propertyValues a PropertyValue[] which should contain all properties of com.sun.star.text.NumberingLevel
     */
    public _NumberingLevel(LogWriter log, TestParameters tParam, PropertyValue[] propertyValues){

        this.PropertyArray = propertyValues;

        this.log = log;

        //key = PropertyName, value = Ooptional
        NumberingLevel.put("Adjust", Boolean.FALSE);
        NumberingLevel.put("ParentNumbering", Boolean.TRUE);
        NumberingLevel.put("Prefix", Boolean.FALSE);
        NumberingLevel.put("Suffix", Boolean.FALSE);
        NumberingLevel.put("CharStyleName", Boolean.TRUE);
        NumberingLevel.put("BulletId", Boolean.TRUE);
        NumberingLevel.put("BulletChar", Boolean.FALSE);
        NumberingLevel.put("BulletFontName", Boolean.FALSE);
        NumberingLevel.put("BulletFont", Boolean.TRUE);
        NumberingLevel.put("GraphicURL", Boolean.FALSE);
        NumberingLevel.put("GraphicBitmap", Boolean.TRUE);
        NumberingLevel.put("GraphicSize", Boolean.TRUE);
        NumberingLevel.put("VertOrient", Boolean.TRUE);
        NumberingLevel.put("StartWith", Boolean.TRUE);
        NumberingLevel.put("LeftMargin", Boolean.FALSE);
        NumberingLevel.put("SymbolTextDistance", Boolean.TRUE);
        NumberingLevel.put("FirstLineOffset", Boolean.FALSE);
        NumberingLevel.put("NumberingType", Boolean.FALSE);
        NumberingLevel.put("HeadingStyleName", Boolean.FALSE);
        NumberingLevel.put("BulletColor", Boolean.TRUE);
        NumberingLevel.put("BulletRelSize", Boolean.TRUE);

    }

    /**
     * This methods checks the PropertyValue for completnes. If one or more properties
     * are missing the return value is FALSE, else TRUE
     * @return returns TRUE if PropertyValue[] is complete, else FALSE
     */
    public boolean testPropertieArray(){

        boolean status = true;
        try{

            // iterate over the given property array and remove it from the must list
            for (int i = 0; i < PropertyArray.length; i++){
                String propertyName=PropertyArray[i].Name;

                if ( NumberingLevel.containsKey(propertyName) ) {
                    NumberingLevel.remove(propertyName);
                } else {
                    if ( status ) {
                        log.println("FAILED: com.sun.star.text.NumberingLevel -> " +
                                    "found not described property:");
                    }

                    status = false;
                    log.println("-> '" + propertyName + "'");
                }

            }

            // get rest of properties and check if they are optional
            if (! NumberingLevel.isEmpty()){
                for (Iterator<String> e = NumberingLevel.keySet().iterator() ; e.hasNext() ;) {
                    String property = e.next();

                    // if some elements are not optional -> failed
                    if ( ! NumberingLevel.get(property).booleanValue() ){

                        if ( status ) {
                            log.println("FAILED: com.sun.star.text.NumberingLevel -> " +
                                        "could not find not optional property:");
                        }

                        status = false;
                        log.println("-> '" + property + "'");
                    }
                }
            }

        }catch( Exception e ){
            throw new StatusException("ERROR: could not test all properties of com.sun.star.text.NumberingLevel",e);
        }

        return status;
    }


}  // finish class _NumberingLevel