com.hs.gpxparser.modal.Extension Maven / Gradle / Ivy

Go to download

package com.hs.gpxparser.modal;

import java.util.HashMap;

/**
 * This class holds generic extension information from any node that can have
 * extensions defined. 

 * 
 * Any custom extension parser used when parsing a gpx file will return a custom
 * object instance that will be kept in properties defined in this class.
 * 
 * 

 * 
 * Multiple extension parsers can be used when parsing. Every extension parser
 * defines an unique id that will be used as a HashMap key for the parsed object
 * values.
 * 
 */
public class Extension {
    protected HashMap extensionData;

    public HashMap getExtensionData() {
        return extensionData;
    }

    /**
     * Setter for extension HashMap.
     * 
     * @param extensionData
     *            - A HashMap with extensions parser ids as keys and parsed
     *            objects as values.
     */
    public void setExtensionData(HashMap extensionData) {
        this.extensionData = extensionData;
    }

    /**
     * Adds a new parsed extension object into the extension data with the key
     * set by parserId.
     * 
     * @param parserId
     *            a unique key representing the id of he extension parser used.
     * @param data
     *            an object holding the parsed information. This can be any
     *            object type and it is the extension parser's job to set it
     *            properly.
     */
    public void addExtensionData(String parserId, Object data) {
        // TFE, 20180217
        // don't add null data - otherwise for each parser one null entry would
        // be added
        // to each extension in a gpx file! That is too much waste considering
        // that in most cases no extensions at all are present
        if (data == null)
            return;

        if (extensionData == null) {
            extensionData = new HashMap<>();
        }
        extensionData.put(parserId, data);
    }

    /**
     * Returns the extension data parsed by the extension parser with id
     * parserId
     * 
     * @param parserId
     *            a String representing the id of an extension parser
     * @return the extension data parsed by the extension parser with id
     *         parserId
     */
    public Object getExtensionData(String parserId) {
        if (extensionData != null) {
            return extensionData.get(parserId);
        } else {
            return null;
        }
    }

    /**
     * Returns the number of extension data objects that are currently set.
     * 
     * @return the number of extension data objects that are currently set.
     */
    public int getExtensionsParsed() {
        if (extensionData != null) {
            return extensionData.size();
        } else {
            return 0;
        }
    }
}