Return-Path: 
 <issues-return-42015-apmail-flink-issues-archive=flink.apache.org@flink.apache.org>
X-Original-To: apmail-flink-issues-archive@minotaur.apache.org
Delivered-To: apmail-flink-issues-archive@minotaur.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 51EDB18702
	for <apmail-flink-issues-archive@minotaur.apache.org>;
 Mon, 25 Jan 2016 10:30:41 +0000 (UTC)
Received: (qmail 92239 invoked by uid 500); 25 Jan 2016 10:30:40 -0000
Delivered-To: apmail-flink-issues-archive@flink.apache.org
Received: (qmail 92160 invoked by uid 500); 25 Jan 2016 10:30:40 -0000
Mailing-List: contact issues-help@flink.apache.org; run by ezmlm
Precedence: bulk
List-Help: <mailto:issues-help@flink.apache.org>
List-Unsubscribe: <mailto:issues-unsubscribe@flink.apache.org>
List-Post: <mailto:issues@flink.apache.org>
List-Id: <issues.flink.apache.org>
Reply-To: dev@flink.apache.org
Delivered-To: mailing list issues@flink.apache.org
Received: (qmail 92052 invoked by uid 99); 25 Jan 2016 10:30:40 -0000
Received: from arcas.apache.org (HELO arcas) (140.211.11.28)
    by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 25 Jan 2016 10:30:40 +0000
Received: from arcas.apache.org (localhost [127.0.0.1])
	by arcas (Postfix) with ESMTP id F336C2C14F0
	for <issues@flink.apache.org>; Mon, 25 Jan 2016 10:30:39 +0000 (UTC)
Date: Mon, 25 Jan 2016 10:30:39 +0000 (UTC)
From: "Kostas (JIRA)" <jira@apache.org>
To: issues@flink.apache.org
Message-ID: <JIRA.12925218.1451726263000.199055.1453717839864@Atlassian.JIRA>
In-Reply-To: <JIRA.12925218.1451726263000@Atlassian.JIRA>
References: <JIRA.12925218.1451726263000@Atlassian.JIRA>
 <JIRA.12925218.1451726263922@arcas>
Subject: [jira] [Assigned] (FLINK-3198) Rename Grouping.getDataSet() method
 and add JavaDocs
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394


     [ https://issues.apache.org/jira/browse/FLINK-3198?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Kostas reassigned FLINK-3198:
-----------------------------

    Assignee: Kostas

> Rename Grouping.getDataSet() method and add JavaDocs
> ----------------------------------------------------
>
>                 Key: FLINK-3198
>                 URL: https://issues.apache.org/jira/browse/FLINK-3198
>             Project: Flink
>          Issue Type: Improvement
>          Components: DataSet API
>    Affects Versions: 1.0.0, 0.10.1
>            Reporter: Fabian Hueske
>            Assignee: Kostas
>             Fix For: 1.0.0, 0.10.2
>
>
> The {{getDataSet()}} method of {{Grouping}} is public and visible to users. It returns the input of the grouping operation which can cause confusion. If this function is used in a regular DataSet program like this
> {code}
> DataSet<X> notGrouped = input.groupBy().getDataSet();
> DataSet<Y> allReduced = notGrouped.reduce()
> {code}
> the previous {{groupBy()}} call is basically discarded and an AllReduce is applied instead of a grouped Reduce.
> Since this method is not meant to be part of the public API we should help users to avoid this method. In the current API, we cannot easily change the visibility of the method without package restructuring or adding additional classes (and hence breaking binary compatibility).
> Instead I proprose to rename the method to something like {{getInputDataSet()}} or {{getGroupingInput()}} and add descriptive JavaDocs.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)