RYA-377 Define the JoinStateStore interface.
Project: http://git-wip-us.apache.org/repos/asf/incubator-rya/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-rya/commit/0a2170a1 Tree: http://git-wip-us.apache.org/repos/asf/incubator-rya/tree/0a2170a1 Diff: http://git-wip-us.apache.org/repos/asf/incubator-rya/diff/0a2170a1 Branch: refs/heads/master Commit: 0a2170a1143266442ab883e86aab9fcd6b365b27 Parents: 653e4b8 Author: kchilton2 <kevin.e.chil...@gmail.com> Authored: Thu Nov 9 14:41:08 2017 -0500 Committer: caleb <caleb.me...@parsons.com> Committed: Tue Jan 9 15:13:00 2018 -0500 ---------------------------------------------------------------------- .../kafka/processors/join/JoinStateStore.java | 53 ++++++++++++++++++++ 1 file changed, 53 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-rya/blob/0a2170a1/extras/rya.streams/kafka/src/main/java/org/apache/rya/streams/kafka/processors/join/JoinStateStore.java ---------------------------------------------------------------------- diff --git a/extras/rya.streams/kafka/src/main/java/org/apache/rya/streams/kafka/processors/join/JoinStateStore.java b/extras/rya.streams/kafka/src/main/java/org/apache/rya/streams/kafka/processors/join/JoinStateStore.java new file mode 100644 index 0000000..e53ec68 --- /dev/null +++ b/extras/rya.streams/kafka/src/main/java/org/apache/rya/streams/kafka/processors/join/JoinStateStore.java @@ -0,0 +1,53 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you 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 org.apache.rya.streams.kafka.processors.join; + +import java.util.Iterator; +import java.util.List; + +import org.apache.rya.api.model.VisibilityBindingSet; +import org.apache.rya.streams.kafka.processors.ProcessorResult.BinaryResult; + +import edu.umd.cs.findbugs.annotations.DefaultAnnotation; +import edu.umd.cs.findbugs.annotations.NonNull; + +/** + * Provides a mechanism for storing {@link VisibilityBindingSet}s that have been emitted from either side of + * a Join and a way to fetch all {@link VisibilityBindingSet}s that join with it from the other side. + */ +@DefaultAnnotation(NonNull.class) +public interface JoinStateStore { + + /** + * Store a {@link VisibilityBindingSet} based on the side it was emitted from. + * + * @param joinVars - An ordered list of the variables that are being joined over. (not null) + * @param result - The result whose value will be stored. (not null) + */ + public void store(List<String> joinVars, BinaryResult result); + + /** + * Get the previously stored {@link VisibilityBindingSet}s that join with the provided result. + * + * @param joinVars - An ordered list of the variables to join over. (not null) + * @param result - Defines the values that will be used to join. (not null) + * @return The {@link VisibilityBinidngSet}s that join with {@code result}. + */ + public Iterator<VisibilityBindingSet> getJoinedValues(List<String> joinVars, BinaryResult result); +} \ No newline at end of file
