/*
 * This Source Code Form is copyright of 51Degrees Mobile Experts Limited.
 * Copyright © 2017 51Degrees Mobile Experts Limited, 5 Charlotte Close,
 * Caversham, Reading, Berkshire, United Kingdom RG4 7BY
 *
 * This Source Code Form is the subject of the following patents and patent
 * applications, owned by 51Degrees Mobile Experts Limited of 5 Charlotte
 * Close, Caversham, Reading, Berkshire, United Kingdom RG4 7BY:
 * European Patent No. 2871816;
 * European Patent Application No. 17184134.9;
 * United States Patent Nos. 9,332,086 and 9,350,823; and
 * United States Patent Application No. 15/686,066.
 *
 * 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 Source Code Form is "Incompatible With Secondary Licenses", as
 * defined by the Mozilla Public License, v. 2.0.
 */

package fiftyone.device.example.illustration;

import fiftyone.device.example.Shared;
import fiftyone.mobile.detection.Dataset;
import fiftyone.mobile.detection.entities.Property;
import fiftyone.mobile.detection.entities.Value;
import fiftyone.mobile.detection.factories.MemoryFactory;

import java.io.Closeable;
import java.io.IOException;

/**
 * <!-- tutorial -->
 * Example of listing properties and possible values from a Dataset
 * <p>
 * The example illustrates:
 * <ol>
 *  <li>Loading a memory-resident Pattern Dataset
 *  <pre class="prettyprint lang-java">
 *  <code>
 *      dataset = MemoryFactory.create(Shared.getLitePatternV32(), true);
 *  </code>
 *  </pre>
 *  <li>Enumerating properties contained in the dataset loaded
 *  <pre class="prettyprint lang-java">
 *  <code>
 *      for(Property property : dataset.getProperties()) {
 *  </code>
 *  </pre>
 *  <li>Accessing description for each property.
 *  <pre class="prettyprint lang-java">
 *  <code>
 *      property.getDescription();
 *  </code>
 *  </pre>
 *  <li>Enumerating values that the property may have
 *  <pre class="prettyprint lang-java">
 *  <code>
 *      for (Value value : property.getValues().getAll()) {
 *  </code>
 *  </pre>
 *  <li>Accessing description of each value
 *  <pre class="prettyprint lang-java">
 *  <code>
 *      if (value.getDescription() != null) {
 *  </code>
 *  </pre>
 * </ol>
 * <!-- tutorial -->
 * The <a href="https://51degrees.com/resources/property-dictionary">
 * 51 Degrees Property Dictionary</a> contains a description of each of the 
 * properties and the editions in which they are available.
 * <p>
 * main assumes it is being run with a working directory at root of 
 * project or of this module.
 */
public class MetadataExample implements Closeable {
    // Snippet Start
    // Dataset created from 51Degrees data file.
    private final Dataset dataset;

    /**
     * Creates a new Dataset using memory factory which creates a 
     * memory-resident representation of data.
     * 
     * @throws IOException if there was a problem reading from the data file.
     */
    public MetadataExample() throws IOException {
        dataset = MemoryFactory.create(Shared.getLitePatternV32(), true);
    }

    /**
     * Lists all properties available in provided data file and all possible 
     * values for each property. 
     * 
     * @throws IOException if there was a problem reading from the data file.
     */
    public void listProperties () throws IOException {
        // iterate over all properties in the dataset
        for(Property property : dataset.getProperties()) {
            //Get individual property, print name and description.
            System.out.format("%s (%s) - %s%n", property.getName(),
                    property.valueType.name(),
                    property.getDescription());

            // collects name, values and their descriptions
            StringBuilder propertyOutput = new StringBuilder();

            // loop over all values for this property and list
            // add a description for this property value if there is one
            for (Value value : property.getValues().getAll()) {
                // add name of property
                propertyOutput.append("\t")
                        .append(truncateToNl(value.getName()));
                // add description if exists
                if (value.getDescription() != null) {
                    propertyOutput.append(" - ")
                            .append(value.getDescription());
                }
                propertyOutput.append("\n");
            }
            System.out.println(propertyOutput);
            propertyOutput.setLength(0);
        }
    }

    // truncate value if it contains newline (esp for the JavaScript property)
    private String truncateToNl(String s) {
        int i = s.indexOf('\n', 3);
        if (i == -1) {
            return s;
        }
        return s.substring(0, i+2) + " ...";
    }

    /**
     * Don't forget to close datasets when you are done with them.
     * 
     * @throws IOException if there was a problem accessing the data file.
     */
    @Override
    public void close() throws IOException {
        dataset.close();
    }


    public static void main(String[] args) throws IOException {
        System.out.println("Starting Metadata Example");
        System.out.print("Loading dataset ...\r");
        MetadataExample example = new MetadataExample();
        try {
            example.listProperties();
        } finally {
            // close example so that dataset gets closed
            example.close();
        }
    }
    // Snippet End
}