From commits-return-46-apmail-datafu-commits-archive=datafu.apache.org@datafu.incubator.apache.org Mon Jan 27 23:54:05 2014 Return-Path: X-Original-To: apmail-datafu-commits-archive@minotaur.apache.org Delivered-To: apmail-datafu-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 0C24110C47 for ; Mon, 27 Jan 2014 23:54:05 +0000 (UTC) Received: (qmail 58826 invoked by uid 500); 27 Jan 2014 23:53:45 -0000 Delivered-To: apmail-datafu-commits-archive@datafu.apache.org Received: (qmail 58797 invoked by uid 500); 27 Jan 2014 23:53:45 -0000 Mailing-List: contact commits-help@datafu.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@datafu.incubator.apache.org Delivered-To: mailing list commits@datafu.incubator.apache.org Received: (qmail 58786 invoked by uid 99); 27 Jan 2014 23:53:45 -0000 Received: from nike.apache.org (HELO nike.apache.org) (192.87.106.230) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 27 Jan 2014 23:53:45 +0000 X-ASF-Spam-Status: No, hits=-2000.5 required=5.0 tests=ALL_TRUSTED,RP_MATCHES_RCVD X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO mail.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with SMTP; Mon, 27 Jan 2014 23:50:57 +0000 Received: (qmail 54966 invoked by uid 99); 27 Jan 2014 23:50:27 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 27 Jan 2014 23:50:27 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 535F1907A36; Mon, 27 Jan 2014 23:50:27 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: wvaughan@apache.org To: commits@datafu.incubator.apache.org Date: Mon, 27 Jan 2014 23:50:38 -0000 Message-Id: In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [13/51] [partial] DATAFU-20 Initial commit of website content X-Virus-Checked: Checked by ClamAV on apache.org http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/424e3b48/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-frame.html ---------------------------------------------------------------------- diff --git a/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-frame.html b/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-frame.html new file mode 100644 index 0000000..5d5eb56 --- /dev/null +++ b/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-frame.html @@ -0,0 +1,32 @@ + + + + + + +datafu.pig.urls (DataFu 1.1.0) + + + + + + + + + + + +datafu.pig.urls + + + + +
+Classes  + +
+UserAgentClassify
+ + + + http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/424e3b48/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-summary.html ---------------------------------------------------------------------- diff --git a/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-summary.html b/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-summary.html new file mode 100644 index 0000000..de0af9c --- /dev/null +++ b/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-summary.html @@ -0,0 +1,172 @@ + + + + + + +datafu.pig.urls (DataFu 1.1.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+

+Package datafu.pig.urls +

+UDFs for processing URLs. +

+See: +
+          Description +

+ + + + + + + + + +
+Class Summary
UserAgentClassifyGiven a user agent string, this UDF classifies clients to 'mobile' and 'desktop'.
+  + +

+

+Package datafu.pig.urls Description +

+ +

+UDFs for processing URLs. +

+ +

+

+
+
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Matthew Hayes, Sam Shah + + http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/424e3b48/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-tree.html ---------------------------------------------------------------------- diff --git a/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-tree.html b/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-tree.html new file mode 100644 index 0000000..b5fd4fe --- /dev/null +++ b/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-tree.html @@ -0,0 +1,157 @@ + + + + + + +datafu.pig.urls Class Hierarchy (DataFu 1.1.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Hierarchy For Package datafu.pig.urls +

+
+
+
Package Hierarchies:
All Packages
+
+

+Class Hierarchy +

+ +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Matthew Hayes, Sam Shah + + http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/424e3b48/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-use.html ---------------------------------------------------------------------- diff --git a/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-use.html b/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-use.html new file mode 100644 index 0000000..6148cc0 --- /dev/null +++ b/site/source/docs/datafu/1.1.0/datafu/pig/urls/package-use.html @@ -0,0 +1,144 @@ + + + + + + +Uses of Package datafu.pig.urls (DataFu 1.1.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+
+

+Uses of Package
datafu.pig.urls

+
+No usage of datafu.pig.urls +

+

+ + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
+ + + +
+Matthew Hayes, Sam Shah + + http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/424e3b48/site/source/docs/datafu/1.1.0/datafu/pig/util/AliasableEvalFunc.html ---------------------------------------------------------------------- diff --git a/site/source/docs/datafu/1.1.0/datafu/pig/util/AliasableEvalFunc.html b/site/source/docs/datafu/1.1.0/datafu/pig/util/AliasableEvalFunc.html new file mode 100644 index 0000000..db99e89 --- /dev/null +++ b/site/source/docs/datafu/1.1.0/datafu/pig/util/AliasableEvalFunc.html @@ -0,0 +1,783 @@ + + + + + + +AliasableEvalFunc (DataFu 1.1.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +datafu.pig.util +
+Class AliasableEvalFunc<T>

+
+java.lang.Object
+  extended by org.apache.pig.EvalFunc<T>
+      extended by datafu.pig.util.ContextualEvalFunc<T>
+          extended by datafu.pig.util.AliasableEvalFunc<T>
+
+
+
Type Parameters:
T -
+
+
Direct Known Subclasses:
BagGroup, BagLeftOuterJoin, Coalesce, TransposeTupleToBag
+
+
+
+
public abstract class AliasableEvalFunc<T>
extends ContextualEvalFunc<T>
+ + +

+Makes implementing and using UDFs easier by enabling named parameters. + +

+ This works by capturing the schema of the input tuple on the front-end and storing it into the UDFContext. + It provides an easy means of referencing the parameters on the back-end to aid in writing schema-based UDFs. +

+ +

+ A related class is SimpleEvalFunc. However they are actually fairly different. The primary purpose of SimpleEvalFunc is + to skip the boilerplate under the assumption that the arguments in and out are well... simple. + It also assumes that these arguments are in a well-defined positional ordering. +

+ +

+ AliasableEvalFunc allows the UDF writer to avoid dealing with all positional assumptions and instead reference fields + by their aliases. This practice allows for more readable code since the alias names should have more meaning + to the reader than the position. This approach is also less error prone since it creates a more explicit contract + for what input the UDF expects and prevents simple mistakes that positional-based UDFs could not easily catch, + such as transposing two fields of the same type. If this contract is violated, say, by attempting to reference + a field that is not present, a meaningful error message may be thrown. +

+ +

+ Example: This example computes the monthly payments for mortgages depending on interest rate. + 

+ public class MortgagePayment extends AliasableEvalFunc<DataBag> {
+    ...
+    public DataBag exec(Tuple input) throws IOException {
+      DataBag output = BagFactory.getInstance().newDefaultBag();
+      
+      Double principal = getDouble(input, "principal"); // get a value from the input tuple by alias
+      Integer numPayments = getInteger(input, "num_payments");
+      DataBag interestRates = getBag(input, "interest_rates");
+    
+      for (Tuple interestTuple : interestRates) {
+        Double interest = getDouble(interestTuple, getPrefixedAliasName("interest_rates", "interest_rate"));  // get a value from the inner bag tuple by alias
+        double monthlyPayment = computeMonthlyPayment(principal, numPayments, interest);
+        output.add(TupleFactory.getInstance().newTuple(monthlyPayment));
+      }
+      return output;
+    }
+  }
+ 
+
+

+

+ +

+

+
Author:
+
wvaughan
+
+
+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.apache.pig.EvalFunc
log, pigLogger, reporter, returnType
+  + + + + + + + + + + +
+Constructor Summary
AliasableEvalFunc() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+ org.apache.pig.data.DataBaggetBag(org.apache.pig.data.Tuple tuple, + java.lang.String alias) + +
+           
+ java.lang.BooleangetBoolean(org.apache.pig.data.Tuple tuple, + java.lang.String alias) + +
+           
+ java.lang.DoublegetDouble(org.apache.pig.data.Tuple tuple, + java.lang.String alias) + +
+           
+ java.lang.DoublegetDouble(org.apache.pig.data.Tuple tuple, + java.lang.String alias, + java.lang.Double defaultValue) + +
+           
+ java.util.Map<java.lang.String,java.lang.Integer>getFieldAliases() + +
+          Field aliases are generated from the input schema
+ Each alias maps to a bag position
+ Inner bags/tuples will have alias of outer.inner.foo
+ java.lang.FloatgetFloat(org.apache.pig.data.Tuple tuple, + java.lang.String alias) + +
+           
+ java.lang.FloatgetFloat(org.apache.pig.data.Tuple tuple, + java.lang.String alias, + java.lang.Float defaultValue) + +
+           
+ java.lang.IntegergetInteger(org.apache.pig.data.Tuple tuple, + java.lang.String alias) + +
+           
+ java.lang.IntegergetInteger(org.apache.pig.data.Tuple tuple, + java.lang.String alias, + java.lang.Integer defaultValue) + +
+           
+ java.lang.LonggetLong(org.apache.pig.data.Tuple tuple, + java.lang.String alias) + +
+           
+ java.lang.LonggetLong(org.apache.pig.data.Tuple tuple, + java.lang.String alias, + java.lang.Long defaultValue) + +
+           
+ java.lang.ObjectgetObject(org.apache.pig.data.Tuple tuple, + java.lang.String alias) + +
+           
+abstract  org.apache.pig.impl.logicalLayer.schema.SchemagetOutputSchema(org.apache.pig.impl.logicalLayer.schema.Schema input) + +
+          Specify the output schema as in {link EvalFunc#outputSchema(Schema)}.
+ java.lang.IntegergetPosition(java.lang.String alias) + +
+           
+ java.lang.IntegergetPosition(java.lang.String prefix, + java.lang.String alias) + +
+           
+ java.lang.StringgetPrefixedAliasName(java.lang.String prefix, + java.lang.String alias) + +
+           
+ java.lang.StringgetString(org.apache.pig.data.Tuple tuple, + java.lang.String alias) + +
+           
+ java.lang.StringgetString(org.apache.pig.data.Tuple tuple, + java.lang.String alias, + java.lang.String defaultValue) + +
+           
+ org.apache.pig.impl.logicalLayer.schema.SchemaoutputSchema(org.apache.pig.impl.logicalLayer.schema.Schema input) + +
+          A wrapper method which captures the schema and then calls getOutputSchema
+  + + + + + + + +
Methods inherited from class datafu.pig.util.ContextualEvalFunc
getContextProperties, getInstanceName, getInstanceProperties, setUDFContextSignature
+  + + + + + + + +
Methods inherited from class org.apache.pig.EvalFunc
exec, finish, getArgToFuncMapping, getCacheFiles, getInputSchema, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, isAsynchronous, progress, setInputSchema, setPigLogger, setReporter, warn
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AliasableEvalFunc

+
+public AliasableEvalFunc()
+
+
+ + + + + + + + +
+Method Detail
+ +

+outputSchema

+
+public org.apache.pig.impl.logicalLayer.schema.Schema outputSchema(org.apache.pig.impl.logicalLayer.schema.Schema input)
+
+
A wrapper method which captures the schema and then calls getOutputSchema +

+

+
Overrides:
outputSchema in class org.apache.pig.EvalFunc<T>
+
+
+
+
+
+
+ +

+getOutputSchema

+
+public abstract org.apache.pig.impl.logicalLayer.schema.Schema getOutputSchema(org.apache.pig.impl.logicalLayer.schema.Schema input)
+
+
Specify the output schema as in {link EvalFunc#outputSchema(Schema)}. +

+

+
Parameters:
input - +
Returns:
outputSchema
+
+
+
+ +

+getPrefixedAliasName

+
+public java.lang.String getPrefixedAliasName(java.lang.String prefix,
+                                             java.lang.String alias)
+
+
+
+
+
+
+ +

+getFieldAliases

+
+public java.util.Map<java.lang.String,java.lang.Integer> getFieldAliases()
+
+
Field aliases are generated from the input schema
+ Each alias maps to a bag position
+ Inner bags/tuples will have alias of outer.inner.foo +

+

+ +
Returns:
A map of field alias to field position
+
+
+
+ +

+getPosition

+
+public java.lang.Integer getPosition(java.lang.String alias)
+
+
+
+
+
+
+ +

+getPosition

+
+public java.lang.Integer getPosition(java.lang.String prefix,
+                                     java.lang.String alias)
+
+
+
+
+
+
+ +

+getInteger

+
+public java.lang.Integer getInteger(org.apache.pig.data.Tuple tuple,
+                                    java.lang.String alias)
+                             throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getInteger

+
+public java.lang.Integer getInteger(org.apache.pig.data.Tuple tuple,
+                                    java.lang.String alias,
+                                    java.lang.Integer defaultValue)
+                             throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getLong

+
+public java.lang.Long getLong(org.apache.pig.data.Tuple tuple,
+                              java.lang.String alias)
+                       throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getLong

+
+public java.lang.Long getLong(org.apache.pig.data.Tuple tuple,
+                              java.lang.String alias,
+                              java.lang.Long defaultValue)
+                       throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getFloat

+
+public java.lang.Float getFloat(org.apache.pig.data.Tuple tuple,
+                                java.lang.String alias)
+                         throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getFloat

+
+public java.lang.Float getFloat(org.apache.pig.data.Tuple tuple,
+                                java.lang.String alias,
+                                java.lang.Float defaultValue)
+                         throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getDouble

+
+public java.lang.Double getDouble(org.apache.pig.data.Tuple tuple,
+                                  java.lang.String alias)
+                           throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getDouble

+
+public java.lang.Double getDouble(org.apache.pig.data.Tuple tuple,
+                                  java.lang.String alias,
+                                  java.lang.Double defaultValue)
+                           throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getString

+
+public java.lang.String getString(org.apache.pig.data.Tuple tuple,
+                                  java.lang.String alias)
+                           throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getString

+
+public java.lang.String getString(org.apache.pig.data.Tuple tuple,
+                                  java.lang.String alias,
+                                  java.lang.String defaultValue)
+                           throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getBoolean

+
+public java.lang.Boolean getBoolean(org.apache.pig.data.Tuple tuple,
+                                    java.lang.String alias)
+                             throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getBag

+
+public org.apache.pig.data.DataBag getBag(org.apache.pig.data.Tuple tuple,
+                                          java.lang.String alias)
+                                   throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+
+ +

+getObject

+
+public java.lang.Object getObject(org.apache.pig.data.Tuple tuple,
+                                  java.lang.String alias)
+                           throws org.apache.pig.backend.executionengine.ExecException
+
+
+ +
Throws: +
org.apache.pig.backend.executionengine.ExecException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Matthew Hayes, Sam Shah + + http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/424e3b48/site/source/docs/datafu/1.1.0/datafu/pig/util/Assert.html ---------------------------------------------------------------------- diff --git a/site/source/docs/datafu/1.1.0/datafu/pig/util/Assert.html b/site/source/docs/datafu/1.1.0/datafu/pig/util/Assert.html new file mode 100644 index 0000000..ba15768 --- /dev/null +++ b/site/source/docs/datafu/1.1.0/datafu/pig/util/Assert.html @@ -0,0 +1,281 @@ + + + + + + +Assert (DataFu 1.1.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +datafu.pig.util +
+Class Assert

+
+java.lang.Object
+  extended by org.apache.pig.EvalFunc<java.lang.Boolean>
+      extended by org.apache.pig.FilterFunc
+          extended by datafu.pig.util.AssertUDF
+              extended by datafu.pig.util.Assert
+
+
+Deprecated. Use AssertUDF instead. +

+

+
@Deprecated
+public class Assert
extends AssertUDF
+ + +

+Assert has been renamed to AssertUDF. + + This class is provided for backward compatibility. +

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.apache.pig.EvalFunc
log, pigLogger, reporter, returnType
+  + + + + + + + + + + +
+Constructor Summary
Assert() + +
+          Deprecated.  
+  + + + + + + + +
+Method Summary
+  + + + + + + + +
Methods inherited from class datafu.pig.util.AssertUDF
exec
+  + + + + + + + +
Methods inherited from class org.apache.pig.FilterFunc
finish
+  + + + + + + + +
Methods inherited from class org.apache.pig.EvalFunc
getArgToFuncMapping, getCacheFiles, getInputSchema, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, isAsynchronous, outputSchema, progress, setInputSchema, setPigLogger, setReporter, setUDFContextSignature, warn
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Assert

+
+public Assert()
+
+
Deprecated. 
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Matthew Hayes, Sam Shah + + http://git-wip-us.apache.org/repos/asf/incubator-datafu/blob/424e3b48/site/source/docs/datafu/1.1.0/datafu/pig/util/AssertUDF.html ---------------------------------------------------------------------- diff --git a/site/source/docs/datafu/1.1.0/datafu/pig/util/AssertUDF.html b/site/source/docs/datafu/1.1.0/datafu/pig/util/AssertUDF.html new file mode 100644 index 0000000..b74db52 --- /dev/null +++ b/site/source/docs/datafu/1.1.0/datafu/pig/util/AssertUDF.html @@ -0,0 +1,324 @@ + + + + + + +AssertUDF (DataFu 1.1.0) + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +datafu.pig.util +
+Class AssertUDF

+
+java.lang.Object
+  extended by org.apache.pig.EvalFunc<java.lang.Boolean>
+      extended by org.apache.pig.FilterFunc
+          extended by datafu.pig.util.AssertUDF
+
+
+
Direct Known Subclasses:
Assert
+
+
+
+
public class AssertUDF
extends org.apache.pig.FilterFunc
+ + +

+Filter function which asserts that a value is true. + +

+ Unfortunately, the Pig interpreter doesn't recognize boolean expressions nested as function + arguments, so this uses C-style booleans. That is, the first argument should be + an integer. 0 is interpreted as "false", and anything else is considered "true". + The function will cause the Pig script to fail if a "false" value is encountered. +

+ +

+ There is a unary and a binary version. The unary version just takes a boolean, and throws out a generic exception message when the + assertion is violated. The binary version takes a String as a second argument and throws that out when the assertion + is violated. +

+ +

+ Example: + 

+ FILTER members BY AssertUDF( (member_id >= 0 ? 1 : 0), 'Doh! Some member ID is negative.' );
+ 
+
+

+

+ +

+

+ +

+ + + + + + + +
+Field Summary
+  + + + + + + + +
Fields inherited from class org.apache.pig.EvalFunc
log, pigLogger, reporter, returnType
+  + + + + + + + + + + +
+Constructor Summary
AssertUDF() + +
+           
+  + + + + + + + + + + + +
+Method Summary
+ java.lang.Booleanexec(org.apache.pig.data.Tuple tuple) + +
+           
+  + + + + + + + +
Methods inherited from class org.apache.pig.FilterFunc
finish
+  + + + + + + + +
Methods inherited from class org.apache.pig.EvalFunc
getArgToFuncMapping, getCacheFiles, getInputSchema, getLogger, getPigLogger, getReporter, getReturnType, getSchemaName, isAsynchronous, outputSchema, progress, setInputSchema, setPigLogger, setReporter, setUDFContextSignature, warn
+  + + + + + + + +
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+AssertUDF

+
+public AssertUDF()
+
+
+ + + + + + + + +
+Method Detail
+ +

+exec

+
+public java.lang.Boolean exec(org.apache.pig.data.Tuple tuple)
+                       throws java.io.IOException
+
+
+
Specified by:
exec in class org.apache.pig.EvalFunc<java.lang.Boolean>
+
+
+ +
Throws: +
java.io.IOException
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+Matthew Hayes, Sam Shah + +