io.datakernel.aggregation.AggregationChunkStorage Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2015 SoftIndex LLC.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.datakernel.aggregation;

import io.datakernel.aggregation.ot.AggregationStructure;
import io.datakernel.async.Promise;
import io.datakernel.codegen.DefiningClassLoader;
import io.datakernel.stream.StreamConsumer;
import io.datakernel.stream.StreamSupplier;

import java.util.List;
import java.util.Set;

/**
 * Manages persistence of aggregations (chunks of data).
 */
public interface AggregationChunkStorage extends IdGenerator {
	/**
	 * Creates a {@code StreamSupplier} that streams records contained in the chunk.
	 * The chunk to read is determined by {@code aggregationId} and {@code id}.
	 *
	 * @param recordClass class of chunk record
	 * @param chunkId     id of chunk
	 * @return StreamSupplier, which will stream read records to its wired consumer.
	 */
	 Promise> read(AggregationStructure aggregation, List fields,
			Class recordClass, C chunkId, DefiningClassLoader classLoader);

	/**
	 * Creates a {@code StreamConsumer} that persists streamed records.
	 * The chunk to write is determined by {@code aggregationId} and {@code id}.
	 *
	 * @param fields      fields of chunk record
	 * @param recordClass class of chunk record
	 * @param chunkId     id of chunk
	 */
	 Promise> write(AggregationStructure aggregation, List fields,
			Class recordClass, C chunkId, DefiningClassLoader classLoader);

	Promise finish(Set chunkIds);

}