DataCollectorBiz.java

/* ===================================================================
 * DataCollectorBiz.java
 * 
 * Created Aug 31, 2008 3:34:46 PM
 * 
 * Copyright (c) 2008 Solarnetwork.net Dev Team.
 * 
 * This program is free software; you can redistribute it and/or 
 * modify it under the terms of the GNU General Public License as 
 * published by the Free Software Foundation; either version 2 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 General Public License 
 * along with this program; if not, write to the Free Software 
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 
 * 02111-1307 USA
 * ===================================================================
 */

package net.solarnetwork.central.in.biz;

import java.util.List;
import net.solarnetwork.central.datum.domain.Datum;
import net.solarnetwork.central.datum.domain.GeneralLocationDatum;
import net.solarnetwork.central.datum.domain.GeneralLocationDatumMetadataFilter;
import net.solarnetwork.central.datum.domain.GeneralLocationDatumMetadataFilterMatch;
import net.solarnetwork.central.datum.domain.GeneralNodeDatum;
import net.solarnetwork.central.datum.domain.GeneralNodeDatumMetadataFilter;
import net.solarnetwork.central.datum.domain.GeneralNodeDatumMetadataFilterMatch;
import net.solarnetwork.central.domain.FilterResults;
import net.solarnetwork.central.domain.Location;
import net.solarnetwork.central.domain.LocationMatch;
import net.solarnetwork.central.domain.SortDescriptor;
import net.solarnetwork.central.domain.SourceLocation;
import net.solarnetwork.central.domain.SourceLocationMatch;
import net.solarnetwork.domain.GeneralDatumMetadata;

/**
 * API for collecting data from solar nodes.
 * 
 * <p>
 * Serves as a transactional facade to posting data into central system.
 * </p>
 * 
 * @author matt.magoffin
 * @version 1.4
 */
public interface DataCollectorBiz {

	/**
	 * Post a new {@link Datum}.
	 * 
	 * @param <D>
	 *        the Datum type
	 * @param datum
	 *        the data to persist
	 * @return the persisted entity
	 * @deprecated See {@link #postGeneralNodeDatum(Iterable)}
	 */
	@Deprecated
	<D extends Datum> D postDatum(D datum);

	/**
	 * Post a collection of datum of {@link Datum} in a single transaction.
	 * 
	 * @param datums
	 *        the collection of datum
	 * @return the persisted entities, ordered in iterator order of
	 *         {@code datums}
	 * @deprecated See {@link #postGeneralNodeDatum(Iterable)}
	 */
	@Deprecated
	List<Datum> postDatum(Iterable<Datum> datums);

	/**
	 * Post a collection of {@link GeneralNodeDatum} in a single transaction.
	 * 
	 * @param datums
	 *        the collection of datums
	 */
	void postGeneralNodeDatum(Iterable<GeneralNodeDatum> datums);

	/**
	 * Post a collection of {@link GeneralLocationDatum} in a single
	 * transaction.
	 * 
	 * @param datums
	 *        the collection of datums
	 * @since 1.3
	 */
	void postGeneralLocationDatum(Iterable<GeneralLocationDatum> datums);

	/**
	 * Add metadata to a specific node and source. If metadata already exists
	 * for the given node and source, the values will be merged such that tags
	 * are only added and only new info values will be added.
	 * 
	 * @param nodeId
	 *        the node ID to add to
	 * @param sourceId
	 *        the source ID to add to
	 * @param meta
	 *        the metadata to add
	 */
	void addGeneralNodeDatumMetadata(Long nodeId, String sourceId, GeneralDatumMetadata meta);

	/**
	 * Search for datum metadata.
	 * 
	 * @param criteria
	 *        the search criteria
	 * @param sortDescriptors
	 *        the optional sort descriptors
	 * @param offset
	 *        an optional result offset
	 * @param max
	 *        an optional maximum number of returned results
	 * @return the results, never <em>null</em>
	 */
	FilterResults<GeneralNodeDatumMetadataFilterMatch> findGeneralNodeDatumMetadata(
			GeneralNodeDatumMetadataFilter criteria, List<SortDescriptor> sortDescriptors,
			Integer offset, Integer max);

	/**
	 * Search for location datum metadata based on a location criteria. The
	 * location and metadata criteria must both match for results to be
	 * included.
	 * 
	 * @param criteria
	 *        the search criteria
	 * @param sortDescriptors
	 *        the optional sort descriptors
	 * @param offset
	 *        an optional result offset
	 * @param max
	 *        an optional maximum number of returned results
	 * @return the results, never <em>null</em>
	 * @since 1.3
	 */
	FilterResults<GeneralLocationDatumMetadataFilterMatch> findGeneralLocationDatumMetadata(
			GeneralLocationDatumMetadataFilter metadataCriteria, List<SortDescriptor> sortDescriptors,
			Integer offset, Integer max);

	/**
	 * Look up PriceLocation objects based on a source name and location name.
	 * 
	 * @param criteria
	 *        the the search criteria
	 * @return the matching location, or <em>null</em> if not found
	 */
	List<SourceLocationMatch> findPriceLocations(SourceLocation criteria);

	/**
	 * Look up price location objects based on a location search filter and sort
	 * options.
	 * 
	 * @param sortDescriptors
	 *        the optional sort descriptors
	 * @param offset
	 *        an optional result offset
	 * @param max
	 *        an optional maximum number of returned results
	 * @return the results, never <em>null</em>
	 */
	FilterResults<SourceLocationMatch> findPriceLocations(SourceLocation criteria,
			List<SortDescriptor> sortDescriptors, Integer offset, Integer max);

	/**
	 * Look up WeatherLocation objects based on a source name and location.
	 * 
	 * <p>
	 * At a minimum the {@link SourceLocation#getSource()} must be provided in
	 * the supplied criteria.
	 * </p>
	 * 
	 * @param criteria
	 *        the search criteria
	 * @return the matching locations, or an empty list if none found
	 */
	List<SourceLocationMatch> findWeatherLocations(SourceLocation criteria);

	/**
	 * Look up weather location objects based on a location search filter and
	 * sort options.
	 * 
	 * @param sortDescriptors
	 *        the optional sort descriptors
	 * @param offset
	 *        an optional result offset
	 * @param max
	 *        an optional maximum number of returned results
	 * @return the results, never <em>null</em>
	 */
	FilterResults<SourceLocationMatch> findWeatherLocations(SourceLocation criteria,
			List<SortDescriptor> sortDescriptors, Integer offset, Integer max);

	/**
	 * Look up location objects based on a location search filter.
	 * 
	 * @param criteria
	 *        the search criteria
	 * @return the matching locations, or an empty list if none found
	 */
	List<LocationMatch> findLocations(Location criteria);

}