Google Git
Sign in
apache / crunch / refs/heads/gh-pages / . / apidocs / com / cloudera / crunch / PGroupedTable.html
blob: 2e4bb65b92168175d5a20404795db4e68d54c468 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_31) on Thu Apr 05 22:07:23 PDT 2012 -->
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<TITLE>
PGroupedTable (crunch 0.2.0 API)
</TITLE>
<META NAME="date" CONTENT="2012-04-05">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="PGroupedTable (crunch 0.2.0 API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PGroupedTable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../com/cloudera/crunch/PCollection.html" title="interface in com.cloudera.crunch"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../com/cloudera/crunch/Pipeline.html" title="interface in com.cloudera.crunch"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/cloudera/crunch/PGroupedTable.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="PGroupedTable.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.cloudera.crunch</FONT>
<BR>
Interface PGroupedTable&lt;K,V&gt;</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../com/cloudera/crunch/PCollection.html" title="interface in com.cloudera.crunch">PCollection</A>&lt;<A HREF="../../../com/cloudera/crunch/Pair.html" title="class in com.cloudera.crunch">Pair</A>&lt;K,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A>&lt;V&gt;&gt;&gt;</DD>
</DL>
<DL>
<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../com/cloudera/crunch/impl/mr/collect/PGroupedTableImpl.html" title="class in com.cloudera.crunch.impl.mr.collect">PGroupedTableImpl</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>PGroupedTable&lt;K,V&gt;</B><DT>extends <A HREF="../../../com/cloudera/crunch/PCollection.html" title="interface in com.cloudera.crunch">PCollection</A>&lt;<A HREF="../../../com/cloudera/crunch/Pair.html" title="class in com.cloudera.crunch">Pair</A>&lt;K,<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</A>&lt;V&gt;&gt;&gt;</DL>
</PRE>
<P>
The Crunch representation of a grouped <A HREF="../../../com/cloudera/crunch/PTable.html" title="interface in com.cloudera.crunch"><CODE>PTable</CODE></A>.
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../com/cloudera/crunch/PTable.html" title="interface in com.cloudera.crunch">PTable</A>&lt;<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">K</A>,<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">V</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/cloudera/crunch/PGroupedTable.html#combineValues(com.cloudera.crunch.CombineFn)">combineValues</A></B>(<A HREF="../../../com/cloudera/crunch/CombineFn.html" title="class in com.cloudera.crunch">CombineFn</A>&lt;<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">K</A>,<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">V</A>&gt;&nbsp;combineFn)</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Combines the values of this grouping using the given <code>CombineFn</code>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>&nbsp;<A HREF="../../../com/cloudera/crunch/PTable.html" title="interface in com.cloudera.crunch">PTable</A>&lt;<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">K</A>,<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">V</A>&gt;</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/cloudera/crunch/PGroupedTable.html#ungroup()">ungroup</A></B>()</CODE>
<BR>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Convert this grouping back into a multimap.</TD>
</TR>
</TABLE>
&nbsp;<A NAME="methods_inherited_from_class_com.cloudera.crunch.PCollection"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
<TH ALIGN="left"><B>Methods inherited from interface com.cloudera.crunch.<A HREF="../../../com/cloudera/crunch/PCollection.html" title="interface in com.cloudera.crunch">PCollection</A></B></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD><CODE><A HREF="../../../com/cloudera/crunch/PCollection.html#count()">count</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#filter(com.cloudera.crunch.FilterFn)">filter</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#getName()">getName</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#getPipeline()">getPipeline</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#getPType()">getPType</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#getSize()">getSize</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#getTypeFamily()">getTypeFamily</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#materialize()">materialize</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#max()">max</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#min()">min</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#parallelDo(com.cloudera.crunch.DoFn, com.cloudera.crunch.type.PTableType)">parallelDo</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#parallelDo(com.cloudera.crunch.DoFn, com.cloudera.crunch.type.PType)">parallelDo</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#parallelDo(java.lang.String, com.cloudera.crunch.DoFn, com.cloudera.crunch.type.PTableType)">parallelDo</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#parallelDo(java.lang.String, com.cloudera.crunch.DoFn, com.cloudera.crunch.type.PType)">parallelDo</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#sample(double)">sample</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#sample(double, long)">sample</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#sort(boolean)">sort</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#union(com.cloudera.crunch.PCollection...)">union</A>, <A HREF="../../../com/cloudera/crunch/PCollection.html#write(com.cloudera.crunch.Target)">write</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="combineValues(com.cloudera.crunch.CombineFn)"><!-- --></A><H3>
combineValues</H3>
<PRE>
<A HREF="../../../com/cloudera/crunch/PTable.html" title="interface in com.cloudera.crunch">PTable</A>&lt;<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">K</A>,<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">V</A>&gt; <B>combineValues</B>(<A HREF="../../../com/cloudera/crunch/CombineFn.html" title="class in com.cloudera.crunch">CombineFn</A>&lt;<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">K</A>,<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">V</A>&gt;&nbsp;combineFn)</PRE>
<DL>
<DD>Combines the values of this grouping using the given <code>CombineFn</code>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>combineFn</CODE> - The combiner function
<DT><B>Returns:</B><DD>A <code>PTable</code> where each key has a single value</DL>
</DD>
</DL>
<HR>
<A NAME="ungroup()"><!-- --></A><H3>
ungroup</H3>
<PRE>
<A HREF="../../../com/cloudera/crunch/PTable.html" title="interface in com.cloudera.crunch">PTable</A>&lt;<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">K</A>,<A HREF="../../../com/cloudera/crunch/PGroupedTable.html" title="type parameter in PGroupedTable">V</A>&gt; <B>ungroup</B>()</PRE>
<DL>
<DD>Convert this grouping back into a multimap.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an ungrouped version of the data in this <code>PGroupedTable</code>.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/PGroupedTable.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../com/cloudera/crunch/PCollection.html" title="interface in com.cloudera.crunch"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../com/cloudera/crunch/Pipeline.html" title="interface in com.cloudera.crunch"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/cloudera/crunch/PGroupedTable.html" target="_top"><B>FRAMES</B></A> &nbsp;
&nbsp;<A HREF="PGroupedTable.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
&nbsp;<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright &#169; 2012. All Rights Reserved.
</BODY>
</HTML>