{"action":"created","comment":{"url":"https://api.github.com/repos/kite-sdk/kite/pulls/comments/24200011","id":24200011,"diff_hunk":"@@ -31,25 +31,52 @@\n import org.kitesdk.data.spi.Registration;\n \n /**\n- * <p>Convenience methods for working with {@link Dataset} instances.</p>\n- *\n+ * Methods for working with {@link Dataset} instances.\n+ * <p>\n+ * <b>URIs</b><br />\n+ * All methods require a URI that identifies a dataset, view, or\n+ * repository. The URI must begin with the scheme {@code dataset:}, \n+ * {@code view:}, or {@code repo:}. The remainder of the URI is \n+ * implementation specific, depending on the dataset scheme.\n+ * <p>\n+ * For example, the URI {@code dataset:hive:/movies/ratings} \n+ * references a Hive dataset named <i>ratings</i> in the\n+ * <i>movies</i> namespace.\n+ * <p>\n+ * The URI {@code view:hdfs:/user/myfiles/movies/ratings?year=2015&month=3}\n+ * references a view of an HDFS dataset named <i>ratings</i> in the\n+ * <i>movies</i> namespace in the {@code /user/myfiles} path. The view \n+ * is filtered to include records from only March, 2015.\n+ * <p>\n+ * See <a href=\"http://kitesdk.org/docs/current/URIs.html\">Dataset and View\n+ * URIs</a>.\n+ * <p>\n+ * <b>Entities</b><br />\n+ * <i>Entities</i> are analagous to <i>records</i> in database terminology.\n+ * The term is used in the API to emphasize that an entity can include not\n+ * only primitive objects, but also complex objects such as hash maps. \n+ *  ","path":"kite-data/kite-data-core/src/main/java/org/kitesdk/data/Datasets.java","position":30,"original_position":30,"commit_id":"9ee8e240f06c69eeb6914d359084dab0a8a5bd11","original_commit_id":"9ee8e240f06c69eeb6914d359084dab0a8a5bd11","user":{"login":"DennisDawson","id":6788473,"avatar_url":"https://avatars.githubusercontent.com/u/6788473?v=3","gravatar_id":"","url":"https://api.github.com/users/DennisDawson","html_url":"https://github.com/DennisDawson","followers_url":"https://api.github.com/users/DennisDawson/followers","following_url":"https://api.github.com/users/DennisDawson/following{/other_user}","gists_url":"https://api.github.com/users/DennisDawson/gists{/gist_id}","starred_url":"https://api.github.com/users/DennisDawson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DennisDawson/subscriptions","organizations_url":"https://api.github.com/users/DennisDawson/orgs","repos_url":"https://api.github.com/users/DennisDawson/repos","events_url":"https://api.github.com/users/DennisDawson/events{/privacy}","received_events_url":"https://api.github.com/users/DennisDawson/received_events","type":"User","site_admin":false},"body":"That is probably a better candidate for packages.html. The URIs section is to give more context for the descriptions of URIs, which appears in every method description. The DatasetDescriptor is linked in every method that uses it. The notes in the header are to clear up what might not be immediately apparent in the short method descriptions.","created_at":"2015-02-05T21:13:28Z","updated_at":"2015-02-05T21:13:28Z","html_url":"https://github.com/kite-sdk/kite/pull/302#discussion_r24200011","pull_request_url":"https://api.github.com/repos/kite-sdk/kite/pulls/302","_links":{"self":{"href":"https://api.github.com/repos/kite-sdk/kite/pulls/comments/24200011"},"html":{"href":"https://github.com/kite-sdk/kite/pull/302#discussion_r24200011"},"pull_request":{"href":"https://api.github.com/repos/kite-sdk/kite/pulls/302"}}},"pull_request":{"url":"https://api.github.com/repos/kite-sdk/kite/pulls/302","id":28675769,"html_url":"https://github.com/kite-sdk/kite/pull/302","diff_url":"https://github.com/kite-sdk/kite/pull/302.diff","patch_url":"https://github.com/kite-sdk/kite/pull/302.patch","issue_url":"https://api.github.com/repos/kite-sdk/kite/issues/302","number":302,"state":"open","locked":false,"title":"CDK-899: Update Datasets.java Javadoc entries.","user":{"login":"DennisDawson","id":6788473,"avatar_url":"https://avatars.githubusercontent.com/u/6788473?v=3","gravatar_id":"","url":"https://api.github.com/users/DennisDawson","html_url":"https://github.com/DennisDawson","followers_url":"https://api.github.com/users/DennisDawson/followers","following_url":"https://api.github.com/users/DennisDawson/following{/other_user}","gists_url":"https://api.github.com/users/DennisDawson/gists{/gist_id}","starred_url":"https://api.github.com/users/DennisDawson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/DennisDawson/subscriptions","organizations_url":"https://api.github.com/users/DennisDawson/orgs","repos_url":"https://api.github.com/users/DennisDawson/repos","events_url":"https://api.github.com/users/DennisDawson/events{/privacy}","received_events_url":"https://api.github.com/users/DennisDawson/received_events","type":"User","site_admin":false},"body":"","created_at":"2015-02-04T21:17:05Z","updated_at":"2015-02-05T21:13:28Z","closed_at":null,"merged_at":null,"merge_commit_sha":"0c14ad0a462286156ee9243898102ca69763fb61","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/kite-sdk/kite/pulls/302/commits","review_comments_url":"https://api.github.com/repos/kite-sdk/kite/pulls/302/comments","review_comment_url":"https://api.github.com/repos/kite-sdk/kite/pulls/comments/{number}","comments_url":"https://api.github.com/repos/kite-sdk/kite/issues/302/comments","statuses_url":"https://api.github.com/repos/kite-sdk/kite/statuses/9ee8e240f06c69eeb6914d359084dab0a8a5bd11","head":{"label":"kite-sdk:updateDatasetsJavadoc","ref":"updateDatasetsJavadoc","sha":"9ee8e240f06c69eeb6914d359084dab0a8a5bd11","user":{"login":"kite-sdk","id":5732728,"avatar_url":"https://avatars.githubusercontent.com/u/5732728?v=3","gravatar_id":"","url":"https://api.github.com/users/kite-sdk","html_url":"https://github.com/kite-sdk","followers_url":"https://api.github.com/users/kite-sdk/followers","following_url":"https://api.github.com/users/kite-sdk/following{/other_user}","gists_url":"https://api.github.com/users/kite-sdk/gists{/gist_id}","starred_url":"https://api.github.com/users/kite-sdk/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kite-sdk/subscriptions","organizations_url":"https://api.github.com/users/kite-sdk/orgs","repos_url":"https://api.github.com/users/kite-sdk/repos","events_url":"https://api.github.com/users/kite-sdk/events{/privacy}","received_events_url":"https://api.github.com/users/kite-sdk/received_events","type":"Organization","site_admin":false},"repo":{"id":14829187,"name":"kite","full_name":"kite-sdk/kite","owner":{"login":"kite-sdk","id":5732728,"avatar_url":"https://avatars.githubusercontent.com/u/5732728?v=3","gravatar_id":"","url":"https://api.github.com/users/kite-sdk","html_url":"https://github.com/kite-sdk","followers_url":"https://api.github.com/users/kite-sdk/followers","following_url":"https://api.github.com/users/kite-sdk/following{/other_user}","gists_url":"https://api.github.com/users/kite-sdk/gists{/gist_id}","starred_url":"https://api.github.com/users/kite-sdk/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kite-sdk/subscriptions","organizations_url":"https://api.github.com/users/kite-sdk/orgs","repos_url":"https://api.github.com/users/kite-sdk/repos","events_url":"https://api.github.com/users/kite-sdk/events{/privacy}","received_events_url":"https://api.github.com/users/kite-sdk/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/kite-sdk/kite","description":"Kite SDK","fork":false,"url":"https://api.github.com/repos/kite-sdk/kite","forks_url":"https://api.github.com/repos/kite-sdk/kite/forks","keys_url":"https://api.github.com/repos/kite-sdk/kite/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kite-sdk/kite/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kite-sdk/kite/teams","hooks_url":"https://api.github.com/repos/kite-sdk/kite/hooks","issue_events_url":"https://api.github.com/repos/kite-sdk/kite/issues/events{/number}","events_url":"https://api.github.com/repos/kite-sdk/kite/events","assignees_url":"https://api.github.com/repos/kite-sdk/kite/assignees{/user}","branches_url":"https://api.github.com/repos/kite-sdk/kite/branches{/branch}","tags_url":"https://api.github.com/repos/kite-sdk/kite/tags","blobs_url":"https://api.github.com/repos/kite-sdk/kite/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kite-sdk/kite/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kite-sdk/kite/git/refs{/sha}","trees_url":"https://api.github.com/repos/kite-sdk/kite/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kite-sdk/kite/statuses/{sha}","languages_url":"https://api.github.com/repos/kite-sdk/kite/languages","stargazers_url":"https://api.github.com/repos/kite-sdk/kite/stargazers","contributors_url":"https://api.github.com/repos/kite-sdk/kite/contributors","subscribers_url":"https://api.github.com/repos/kite-sdk/kite/subscribers","subscription_url":"https://api.github.com/repos/kite-sdk/kite/subscription","commits_url":"https://api.github.com/repos/kite-sdk/kite/commits{/sha}","git_commits_url":"https://api.github.com/repos/kite-sdk/kite/git/commits{/sha}","comments_url":"https://api.github.com/repos/kite-sdk/kite/comments{/number}","issue_comment_url":"https://api.github.com/repos/kite-sdk/kite/issues/comments/{number}","contents_url":"https://api.github.com/repos/kite-sdk/kite/contents/{+path}","compare_url":"https://api.github.com/repos/kite-sdk/kite/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kite-sdk/kite/merges","archive_url":"https://api.github.com/repos/kite-sdk/kite/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kite-sdk/kite/downloads","issues_url":"https://api.github.com/repos/kite-sdk/kite/issues{/number}","pulls_url":"https://api.github.com/repos/kite-sdk/kite/pulls{/number}","milestones_url":"https://api.github.com/repos/kite-sdk/kite/milestones{/number}","notifications_url":"https://api.github.com/repos/kite-sdk/kite/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kite-sdk/kite/labels{/name}","releases_url":"https://api.github.com/repos/kite-sdk/kite/releases{/id}","created_at":"2013-11-30T22:06:02Z","updated_at":"2015-02-05T02:06:41Z","pushed_at":"2015-02-05T00:42:42Z","git_url":"git://github.com/kite-sdk/kite.git","ssh_url":"git@github.com:kite-sdk/kite.git","clone_url":"https://github.com/kite-sdk/kite.git","svn_url":"https://github.com/kite-sdk/kite","homepage":"http://kitesdk.org/docs/current/","size":73146,"stargazers_count":103,"watchers_count":103,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":81,"mirror_url":null,"open_issues_count":10,"forks":81,"open_issues":10,"watchers":103,"default_branch":"master"}},"base":{"label":"kite-sdk:master","ref":"master","sha":"ca993b8152e9d84ce94837aac102ecf8b5dc563c","user":{"login":"kite-sdk","id":5732728,"avatar_url":"https://avatars.githubusercontent.com/u/5732728?v=3","gravatar_id":"","url":"https://api.github.com/users/kite-sdk","html_url":"https://github.com/kite-sdk","followers_url":"https://api.github.com/users/kite-sdk/followers","following_url":"https://api.github.com/users/kite-sdk/following{/other_user}","gists_url":"https://api.github.com/users/kite-sdk/gists{/gist_id}","starred_url":"https://api.github.com/users/kite-sdk/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kite-sdk/subscriptions","organizations_url":"https://api.github.com/users/kite-sdk/orgs","repos_url":"https://api.github.com/users/kite-sdk/repos","events_url":"https://api.github.com/users/kite-sdk/events{/privacy}","received_events_url":"https://api.github.com/users/kite-sdk/received_events","type":"Organization","site_admin":false},"repo":{"id":14829187,"name":"kite","full_name":"kite-sdk/kite","owner":{"login":"kite-sdk","id":5732728,"avatar_url":"https://avatars.githubusercontent.com/u/5732728?v=3","gravatar_id":"","url":"https://api.github.com/users/kite-sdk","html_url":"https://github.com/kite-sdk","followers_url":"https://api.github.com/users/kite-sdk/followers","following_url":"https://api.github.com/users/kite-sdk/following{/other_user}","gists_url":"https://api.github.com/users/kite-sdk/gists{/gist_id}","starred_url":"https://api.github.com/users/kite-sdk/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kite-sdk/subscriptions","organizations_url":"https://api.github.com/users/kite-sdk/orgs","repos_url":"https://api.github.com/users/kite-sdk/repos","events_url":"https://api.github.com/users/kite-sdk/events{/privacy}","received_events_url":"https://api.github.com/users/kite-sdk/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/kite-sdk/kite","description":"Kite SDK","fork":false,"url":"https://api.github.com/repos/kite-sdk/kite","forks_url":"https://api.github.com/repos/kite-sdk/kite/forks","keys_url":"https://api.github.com/repos/kite-sdk/kite/keys{/key_id}","collaborators_url":"https://api.github.com/repos/kite-sdk/kite/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/kite-sdk/kite/teams","hooks_url":"https://api.github.com/repos/kite-sdk/kite/hooks","issue_events_url":"https://api.github.com/repos/kite-sdk/kite/issues/events{/number}","events_url":"https://api.github.com/repos/kite-sdk/kite/events","assignees_url":"https://api.github.com/repos/kite-sdk/kite/assignees{/user}","branches_url":"https://api.github.com/repos/kite-sdk/kite/branches{/branch}","tags_url":"https://api.github.com/repos/kite-sdk/kite/tags","blobs_url":"https://api.github.com/repos/kite-sdk/kite/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/kite-sdk/kite/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/kite-sdk/kite/git/refs{/sha}","trees_url":"https://api.github.com/repos/kite-sdk/kite/git/trees{/sha}","statuses_url":"https://api.github.com/repos/kite-sdk/kite/statuses/{sha}","languages_url":"https://api.github.com/repos/kite-sdk/kite/languages","stargazers_url":"https://api.github.com/repos/kite-sdk/kite/stargazers","contributors_url":"https://api.github.com/repos/kite-sdk/kite/contributors","subscribers_url":"https://api.github.com/repos/kite-sdk/kite/subscribers","subscription_url":"https://api.github.com/repos/kite-sdk/kite/subscription","commits_url":"https://api.github.com/repos/kite-sdk/kite/commits{/sha}","git_commits_url":"https://api.github.com/repos/kite-sdk/kite/git/commits{/sha}","comments_url":"https://api.github.com/repos/kite-sdk/kite/comments{/number}","issue_comment_url":"https://api.github.com/repos/kite-sdk/kite/issues/comments/{number}","contents_url":"https://api.github.com/repos/kite-sdk/kite/contents/{+path}","compare_url":"https://api.github.com/repos/kite-sdk/kite/compare/{base}...{head}","merges_url":"https://api.github.com/repos/kite-sdk/kite/merges","archive_url":"https://api.github.com/repos/kite-sdk/kite/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/kite-sdk/kite/downloads","issues_url":"https://api.github.com/repos/kite-sdk/kite/issues{/number}","pulls_url":"https://api.github.com/repos/kite-sdk/kite/pulls{/number}","milestones_url":"https://api.github.com/repos/kite-sdk/kite/milestones{/number}","notifications_url":"https://api.github.com/repos/kite-sdk/kite/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/kite-sdk/kite/labels{/name}","releases_url":"https://api.github.com/repos/kite-sdk/kite/releases{/id}","created_at":"2013-11-30T22:06:02Z","updated_at":"2015-02-05T02:06:41Z","pushed_at":"2015-02-05T00:42:42Z","git_url":"git://github.com/kite-sdk/kite.git","ssh_url":"git@github.com:kite-sdk/kite.git","clone_url":"https://github.com/kite-sdk/kite.git","svn_url":"https://github.com/kite-sdk/kite","homepage":"http://kitesdk.org/docs/current/","size":73146,"stargazers_count":103,"watchers_count":103,"language":"Java","has_issues":true,"has_downloads":true,"has_wiki":true,"has_pages":true,"forks_count":81,"mirror_url":null,"open_issues_count":10,"forks":81,"open_issues":10,"watchers":103,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/kite-sdk/kite/pulls/302"},"html":{"href":"https://github.com/kite-sdk/kite/pull/302"},"issue":{"href":"https://api.github.com/repos/kite-sdk/kite/issues/302"},"comments":{"href":"https://api.github.com/repos/kite-sdk/kite/issues/302/comments"},"review_comments":{"href":"https://api.github.com/repos/kite-sdk/kite/pulls/302/comments"},"review_comment":{"href":"https://api.github.com/repos/kite-sdk/kite/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/kite-sdk/kite/pulls/302/commits"},"statuses":{"href":"https://api.github.com/repos/kite-sdk/kite/statuses/9ee8e240f06c69eeb6914d359084dab0a8a5bd11"}}}}