Skip to content

Commit

Permalink
[FLINK-1380] [streaming] Updated SplitDataStream to extend DataStream…
Browse files Browse the repository at this point in the history
… to get rid of selectAll method for splits
  • Loading branch information
gyfora authored and mbalassi committed Jan 12, 2015
1 parent d908ca1 commit 9f07373
Show file tree
Hide file tree
Showing 6 changed files with 77 additions and 94 deletions.
2 changes: 1 addition & 1 deletion docs/streaming_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,7 @@ DataStream<Integer> odd = split.select("odd");
In the above example the data stream named ‘even’ will only contain elements that are directed to the output named “even”. The user can of course further transform these new stream by for example squaring only the even elements.
Data streams only receive the elements directed to selected output names. The user can also select multiple output names by `splitStream.select(“output1”, “output2”…)`. It is common that a stream listens to all the outputs, so `split.selectAll()` provides this functionality without having to select all names.
Data streams only receive the elements directed to selected output names. The user can also select multiple output names by `splitStream.select(“output1”, “output2”…)`. It is common that a stream listens to all the outputs, by simply applying the transformation on the split data stream without select provides this functionality.
The outputs of an operator are directed by implementing a selector function (implementing the `OutputSelector` interface):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ public DataStream(StreamExecutionEnvironment environment, String operatorType,
this.degreeOfParallelism = environment.getDegreeOfParallelism();
this.jobGraphBuilder = environment.getJobGraphBuilder();
this.userDefinedNames = new ArrayList<String>();
this.selectAll = false;
this.selectAll = true;
this.partitioner = new DistributePartitioner<OUT>(true);
this.typeInfo = typeInfo;
this.mergedStreams = new ArrayList<DataStream<OUT>>();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,21 @@
public class SingleOutputStreamOperator<OUT, O extends SingleOutputStreamOperator<OUT, O>> extends
DataStream<OUT> {

protected boolean isSplit;

protected SingleOutputStreamOperator(StreamExecutionEnvironment environment,
String operatorType, TypeInformation<OUT> outTypeInfo) {
super(environment, operatorType, outTypeInfo);
setBufferTimeout(environment.getBufferTimeout());
this.isSplit = false;
}

@SuppressWarnings("unchecked")
protected SingleOutputStreamOperator(DataStream<OUT> dataStream) {
super(dataStream);
if (dataStream instanceof SingleOutputStreamOperator) {
this.isSplit = ((SingleOutputStreamOperator<OUT, ?>) dataStream).isSplit;
}
}

@SuppressWarnings("unchecked")
Expand Down Expand Up @@ -101,15 +108,21 @@ public SingleOutputStreamOperator<OUT, O> setBufferTimeout(long timeoutMillis) {
* @return The {@link SplitDataStream}
*/
public SplitDataStream<OUT> split(OutputSelector<OUT> outputSelector) {
try {
jobGraphBuilder.setOutputSelector(id,
SerializationUtils.serialize(clean(outputSelector)));

} catch (SerializationException e) {
throw new RuntimeException("Cannot serialize OutputSelector");
if (!isSplit) {
this.isSplit = true;
try {
jobGraphBuilder.setOutputSelector(id,
SerializationUtils.serialize(clean(outputSelector)));

} catch (SerializationException e) {
throw new RuntimeException("Cannot serialize OutputSelector");
}

return new SplitDataStream<OUT>(this);
} else {
throw new RuntimeException("Currently operators can only be split once");
}

return new SplitDataStream<OUT>(this);
}

/**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,79 +1,58 @@
/*
* 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:https://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
* 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:https://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.flink.streaming.api.datastream;

import java.util.Arrays;
*/

import org.apache.flink.api.common.typeinfo.TypeInformation;
import org.apache.flink.streaming.api.collector.OutputSelector;

/**
* The SplitDataStream represents an operator that has been split using an
* {@link OutputSelector}. Named outputs can be selected using the
* {@link #select} function.
*
* @param <OUT>
* The type of the output.
*/
public class SplitDataStream<OUT> {

DataStream<OUT> dataStream;

protected SplitDataStream(DataStream<OUT> dataStream) {
this.dataStream = dataStream.copy();
}
package org.apache.flink.streaming.api.datastream;

import java.util.Arrays;

import org.apache.flink.streaming.api.collector.OutputSelector;

/**
* The SplitDataStream represents an operator that has been split using an
* {@link OutputSelector}. Named outputs can be selected using the
* {@link #select} function. To apply transformation on the whole output simply
* call the transformation on the SplitDataStream
*
* @param <OUT>
* The type of the output.
*/
public class SplitDataStream<OUT> extends DataStream<OUT> {

protected SplitDataStream(DataStream<OUT> dataStream) {
super(dataStream);
}

/**
* Gets the output type.
* Sets the output names for which the next operator will receive values.
*
* @return The output type.
* @param outputNames
* The output names for which the operator will receive the
* input.
* @return Returns the selected DataStream
*/
public TypeInformation<OUT> getOutputType() {
return dataStream.getType();
public DataStream<OUT> select(String... outputNames) {
return selectOutput(outputNames);
}

private DataStream<OUT> selectOutput(String[] outputNames) {
DataStream<OUT> returnStream = copy();
returnStream.selectAll = false;
returnStream.userDefinedNames = Arrays.asList(outputNames);
return returnStream;
}

/**
* Sets the output names for which the next operator will receive values.
*
* @param outputNames
* The output names for which the operator will receive the
* input.
* @return Returns the selected DataStream
*/
public DataStream<OUT> select(String... outputNames) {
return selectOutput(outputNames);
}

/**
* Selects all output names from a split data stream.
*
* @return Returns the selected DataStream
*/
public DataStream<OUT> selectAll() {
DataStream<OUT> returnStream = dataStream.copy();
returnStream.selectAll = true;
return returnStream;
}

private DataStream<OUT> selectOutput(String[] outputNames) {
DataStream<OUT> returnStream = dataStream.copy();
returnStream.userDefinedNames = Arrays.asList(outputNames);
return returnStream;
}

}

}
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ public void outputSelectorTest() throws Exception {
source.select(EVEN).addSink(new ListSink(EVEN));
source.select(ODD, TEN).addSink(new ListSink(ODD_AND_TEN));
source.select(EVEN, ODD).addSink(new ListSink(EVEN_AND_ODD));
source.selectAll().addSink(new ListSink(ALL));
source.addSink(new ListSink(ALL));

env.execute();
assertEquals(Arrays.asList(2L, 4L, 6L, 8L, 10L), outputs.get(EVEN));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,26 +23,17 @@ import org.apache.flink.streaming.api.datastream.{ SplitDataStream => SplitJavaS
/**
* The SplitDataStream represents an operator that has been split using an
* {@link OutputSelector}. Named outputs can be selected using the
* {@link #select} function.
* {@link #select} function. To apply a transformation on the whole output simply call
* the appropriate method on this stream.
*
* @param <OUT>
* The type of the output.
*/
class SplitDataStream[T](javaStream: SplitJavaStream[T]) {

/**
* Gets the underlying java DataStream object.
*/
private[flink] def getJavaStream: SplitJavaStream[T] = javaStream
class SplitDataStream[T](javaStream: SplitJavaStream[T]) extends DataStream[T](javaStream){

/**
* Sets the output names for which the next operator will receive values.
*/
def select(outputNames: String*): DataStream[T] = javaStream.select(outputNames: _*)

/**
* Selects all output names from a split data stream.
*/
def selectAll(): DataStream[T] = javaStream.selectAll()


}

0 comments on commit 9f07373

Please sign in to comment.