fr.inria.eventcloud.api.PublishApi Maven / Gradle / Ivy

Go to download
/**
 * Copyright (c) 2011-2013 INRIA.
 * 
 * This program is free software: you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License as published by the Free
 * Software Foundation, either version 3 of the License, or (at your option) any
 * later version.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see 
 **/
package fr.inria.eventcloud.api;

import java.net.URL;
import java.util.Collection;

import fr.inria.eventcloud.api.Quadruple.SerializationFormat;

/**
 * Defines the publish operations that can be executed on an EventCloud.
 * 
 * @author lpellegr
 */
public interface PublishApi {

    /**
     * Publishes the specified quadruple. This method must be used with care
     * because it is not intended to be used for publishing the quadruples from
     * a compound event but separate events represented as a quadruple.
     * 
     * @param quad
     *            the quadruple to publish.
     */
    // TODO: should be removed or refactored to prevent bad uses
    void publish(Quadruple quad);

    /**
     * Publishes the specified compound event.
     * 
     * @param event
     *            the compound event to publish.
     */
    void publish(CompoundEvent event);

    /**
     * Publishes the specified collection of {@link CompoundEvent}s.
     * 
     * @param events
     *            the compound events to publish.
     */
    void publish(Collection events);

    /**
     * Publishes the quadruples that are read from an input stream opened from
     * the specified URL. The input stream is assumed to comply with the TriG or N-Quads syntax.
     * 
     * @param url
     *            the URL from where the quadruples are read.
     * 
     * @param format
     *            the format that is used to read the data from the input
     *            stream.
     */
    void publish(URL url, SerializationFormat format);

}