WeatherParser.java

/**
 * Copyright (c) 2010-2016 by the respective copyright holders.
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 */
package org.openhab.binding.weather.internal.parser;

import java.io.InputStream;

import org.openhab.binding.weather.internal.model.Weather;

/**
 * Weather parser definition.
 *
 * @author Gerhard Riegler
 * @since 1.6.0
 */
public interface WeatherParser {

    /**
     * Parses the InputStream into the weather object.
     */
    public void parseInto(InputStream is, Weather weather) throws Exception;

    /**
     * Sets the property of the weather object with the value.
     */
    public void setValue(Weather weather, String propertyName, String value);

    /**
     * Returns a new forecast object if the property marks the start of forecast
     * data in the stream.
     */
    public Weather startIfForecast(Weather weather, String propertyName);

    /**
     * Adds the forecast to the weather object if the property marks the end of
     * forecast data in the stream.
     */
    public boolean endIfForecast(Weather weather, Weather forecast, String propertyName);

    /**
     * Postprocess the weather and each forecast object.
     */
    public void postProcessEach(Weather weather) throws Exception;

    /**
     * Postprocess only the weather object.
     */
    public void postProcess(Weather weather) throws Exception;
}