You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pig.apache.org by gk...@apache.org on 2009/09/09 19:57:47 UTC
svn commit: r813060 [2/2] - in /hadoop/pig/trunk: CHANGES.txt build.xml
lib/jdiff/ lib/jdiff/pig_0.3.1.xml
Added: hadoop/pig/trunk/lib/jdiff/pig_0.3.1.xml
URL: http://svn.apache.org/viewvc/hadoop/pig/trunk/lib/jdiff/pig_0.3.1.xml?rev=813060&view=auto
==============================================================================
--- hadoop/pig/trunk/lib/jdiff/pig_0.3.1.xml (added)
+++ hadoop/pig/trunk/lib/jdiff/pig_0.3.1.xml Wed Sep 9 17:57:46 2009
@@ -0,0 +1,37194 @@
+<?xml version="1.0" encoding="iso-8859-1" standalone="no"?>
+<!--
+ 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://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.
+-->
+<!-- Generated by the JDiff Javadoc doclet -->
+<!-- (http://www.jdiff.org) -->
+<!-- on Mon Sep 07 22:28:48 PDT 2009 -->
+
+<api
+ xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
+ xsi:noNamespaceSchemaLocation='api.xsd'
+ name="pig 0.3.1"
+ jdversion="1.0.9">
+
+<!-- Command line arguments = -doclet jdiff.JDiff -docletpath /home/gkesavan/clean_code/pig/branch-0.3/build/ivy/lib/Pig/jdiff-1.0.9.jar:/home/gkesavan/clean_code/pig/branch-0.3/build/ivy/lib/Pig/xerces-1.4.4.jar -classpath /home/gkesavan/clean_code/pig/branch-0.3/lib/hbase-0.18.1.jar:/home/gkesavan/clean_code/pig/branch-0.3/lib/hbase-0.18.1-test.jar:/home/gkesavan/.ivy2/cache/com.jcraft/jsch/jars/jsch-0.1.38.jar:/home/gkesavan/.ivy2/cache/jline/jline/jars/jline-0.9.94.jar:/home/gkesavan/.ivy2/cache/net.java.dev.javacc/javacc/jars/javacc-4.2.jar:/home/gkesavan/.ivy2/cache/junit/junit/jars/junit-4.5.jar:/home/gkesavan/clean_code/pig/branch-0.3/build/pig-0.3.1.jar -sourcepath /home/gkesavan/clean_code/pig/branch-0.3/src -apidir /home/gkesavan/clean_code/pig/branch-0.3/lib/jdiff -apiname pig 0.3.1 -->
+<package name="org.apache.pig">
+ <!-- start interface org.apache.pig.Algebraic -->
+ <interface name="Algebraic" abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <method name="getInitial" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@return A string to instatiate f_init. f_init should be an eval func]]>
+ </doc>
+ </method>
+ <method name="getIntermed" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@return A string to instantiate f_intermed. f_intermed should be an eval func]]>
+ </doc>
+ </method>
+ <method name="getFinal" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@return A string to instantiate f_final. f_final should be an eval func parametrized by
+ the same datum as the eval func implementing this interface]]>
+ </doc>
+ </method>
+ <doc>
+ <![CDATA[An interface to declare that an EvalFunc's
+ calculation can be decomposed into intitial, intermediate, and final steps.
+ More formally, suppose we have to compute an function f over a bag X. In general, we need to know the entire X
+ before we can make any progress on f. However, some functions are <i>algebraic</i> e.g. SUM. In
+ these cases, you can apply some initital function f_init on subsets of X to get partial results.
+ You can then combine partial results from different subsets of X using an intermediate function
+ f_intermed. To get the final answers, several partial results can be combined by invoking a final
+ f_final function. For the function SUM, f_init, f_intermed, and f_final are all SUM.
+
+ See the code for builtin AVG to get a better idea of how algebraic works.
+
+ When eval functions implement this interface, it is a hint to the system to try and compute
+ partial results early which causes queries to run faster.]]>
+ </doc>
+ </interface>
+ <!-- end interface org.apache.pig.Algebraic -->
+ <!-- start class org.apache.pig.ComparisonFunc -->
+ <class name="ComparisonFunc" extends="org.apache.hadoop.io.WritableComparator"
+ abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <constructor name="ComparisonFunc"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </constructor>
+ <method name="compare" return="int"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="a" type="org.apache.hadoop.io.WritableComparable"/>
+ <param name="b" type="org.apache.hadoop.io.WritableComparable"/>
+ </method>
+ <method name="compare" return="int"
+ abstract="true" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="t1" type="org.apache.pig.data.Tuple"/>
+ <param name="t2" type="org.apache.pig.data.Tuple"/>
+ <doc>
+ <![CDATA[This callback method must be implemented by all subclasses. Compares
+ its two arguments for order. Returns a negative integer, zero, or a
+ positive integer as the first argument is less than, equal to, or
+ greater than the second. The order of elements of the tuples correspond
+ to the fields specified in the order by clause.
+ Same semantics as {@link java.util.Comparator}.
+
+ @param t1 the first Tuple to be compared.
+ @param t2 the second Tuple to be compared.
+ @throws IOException
+ @see java.util.Comparator]]>
+ </doc>
+ </method>
+ <method name="setReporter"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="reporter" type="org.apache.pig.backend.hadoop.executionengine.physicalLayer.PigProgressable"/>
+ </method>
+ <field name="reporter" type="org.apache.pig.backend.hadoop.executionengine.physicalLayer.PigProgressable"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ </class>
+ <!-- end class org.apache.pig.ComparisonFunc -->
+ <!-- start class org.apache.pig.EvalFunc -->
+ <class name="EvalFunc" extends="java.lang.Object"
+ abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <constructor name="EvalFunc"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </constructor>
+ <method name="getSchemaName" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ <param name="name" type="java.lang.String"/>
+ <param name="input" type="org.apache.pig.impl.logicalLayer.schema.Schema"/>
+ </method>
+ <method name="getReturnType" return="java.lang.reflect.Type"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="progress"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="true" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="warn"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="true" visibility="public"
+ deprecated="not deprecated">
+ <param name="msg" type="java.lang.String"/>
+ <param name="warningEnum" type="java.lang.Enum"/>
+ </method>
+ <method name="finish"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Placeholder for cleanup to be performed at the end. User defined functions can override.]]>
+ </doc>
+ </method>
+ <method name="exec" return="java.lang.Object"
+ abstract="true" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="input" type="org.apache.pig.data.Tuple"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[This callback method must be implemented by all subclasses. This
+ is the method that will be invoked on every Tuple of a given dataset.
+ Since the dataset may be divided up in a variety of ways the programmer
+ should not make assumptions about state that is maintained between
+ invocations of this method.
+
+ @param input the Tuple to be processed.
+ @return result, of type T.
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="outputSchema" return="org.apache.pig.impl.logicalLayer.schema.Schema"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="input" type="org.apache.pig.impl.logicalLayer.schema.Schema"/>
+ <doc>
+ <![CDATA[@param input Schema of the input
+ @return Schema of the output]]>
+ </doc>
+ </method>
+ <method name="isAsynchronous" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[This function should be overriden to return true for functions that return their values
+ asynchronously. Currently pig never attempts to execute a function
+ asynchronously.
+ @return true if the function can be executed asynchronously.]]>
+ </doc>
+ </method>
+ <method name="getReporter" return="org.apache.pig.backend.hadoop.executionengine.physicalLayer.PigProgressable"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="setReporter"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="true" visibility="public"
+ deprecated="not deprecated">
+ <param name="reporter" type="org.apache.pig.backend.hadoop.executionengine.physicalLayer.PigProgressable"/>
+ </method>
+ <method name="getArgToFuncMapping" return="java.util.List"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="FrontendException" type="org.apache.pig.impl.logicalLayer.FrontendException"/>
+ <doc>
+ <![CDATA[@return A List containing FuncSpec objects representing the Function class
+ which can handle the inputs corresponding to the schema in the objects]]>
+ </doc>
+ </method>
+ <method name="getPigLogger" return="org.apache.pig.backend.hadoop.executionengine.physicalLayer.PigLogger"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="setPigLogger"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="true" visibility="public"
+ deprecated="not deprecated">
+ <param name="pigLogger" type="org.apache.pig.backend.hadoop.executionengine.physicalLayer.PigLogger"/>
+ </method>
+ <method name="getLogger" return="org.apache.commons.logging.Log"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <field name="reporter" type="org.apache.pig.backend.hadoop.executionengine.physicalLayer.PigProgressable"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ <field name="log" type="org.apache.commons.logging.Log"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ <field name="pigLogger" type="org.apache.pig.backend.hadoop.executionengine.physicalLayer.PigLogger"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ <field name="returnType" type="java.lang.reflect.Type"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ <doc>
+ <![CDATA[The class is used to implement functions to be applied to
+ a dataset. The function is applied to each Tuple in the set.
+ The programmer should not make assumptions about state maintained
+ between invocations of the invoke() method since the Pig runtime
+ will schedule and localize invocations based on information provided
+ at runtime. The programmer also should not make assumptions about when or
+ how many times the class will be instantiated, since it may be instantiated
+ multiple times in both the front and back end.]]>
+ </doc>
+ </class>
+ <!-- end class org.apache.pig.EvalFunc -->
+ <!-- start class org.apache.pig.ExecType -->
+ <class name="ExecType" extends="java.lang.Enum"
+ abstract="false"
+ static="false" final="true" visibility="public"
+ deprecated="not deprecated">
+ <implements name="java.io.Serializable"/>
+ <method name="values" return="org.apache.pig.ExecType[]"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="valueOf" return="org.apache.pig.ExecType"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="name" type="java.lang.String"/>
+ </method>
+ <field name="LOCAL" type="org.apache.pig.ExecType"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Run everything on the local machine]]>
+ </doc>
+ </field>
+ <field name="MAPREDUCE" type="org.apache.pig.ExecType"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Use the Hadoop Map/Reduce framework]]>
+ </doc>
+ </field>
+ <field name="PIG" type="org.apache.pig.ExecType"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Use the Experimental Hadoop framework; not available yet.]]>
+ </doc>
+ </field>
+ <doc>
+ <![CDATA[The type of query execution]]>
+ </doc>
+ </class>
+ <!-- end class org.apache.pig.ExecType -->
+ <!-- start class org.apache.pig.FilterFunc -->
+ <class name="FilterFunc" extends="org.apache.pig.EvalFunc"
+ abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <constructor name="FilterFunc"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </constructor>
+ <method name="finish"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Placeholder for cleanup to be performed at the end. User defined functions can override.]]>
+ </doc>
+ </method>
+ </class>
+ <!-- end class org.apache.pig.FilterFunc -->
+ <!-- start class org.apache.pig.FuncSpec -->
+ <class name="FuncSpec" extends="java.lang.Object"
+ abstract="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <implements name="java.io.Serializable"/>
+ <implements name="java.lang.Cloneable"/>
+ <constructor name="FuncSpec" type="java.lang.String, java.lang.String"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@param className the name of the class for the udf
+ @param ctorArg the argument for the constructor for the above class]]>
+ </doc>
+ </constructor>
+ <constructor name="FuncSpec" type="java.lang.String, java.lang.String[]"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@param className the name of the class for the udf
+ @param ctorArgs the arguments for the constructor for the above class]]>
+ </doc>
+ </constructor>
+ <constructor name="FuncSpec" type="java.lang.String, java.lang.String[], org.apache.pig.impl.logicalLayer.schema.Schema"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@param className the name of the class for the udf
+ @param ctorArgs the arguments for the constructor for the above class
+ @param inputArgsSchema schema for input args taken by this Function]]>
+ </doc>
+ </constructor>
+ <constructor name="FuncSpec" type="java.lang.String"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@param funcSpec the name of the function and any arguments.
+ It should have the form: classname('arg1', 'arg2', ...)]]>
+ </doc>
+ </constructor>
+ <constructor name="FuncSpec" type="java.lang.String, org.apache.pig.impl.logicalLayer.schema.Schema"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@param funcSpec funcSpec the name of the function and any arguments.
+ It should have the form: classname('arg1', 'arg2', ...)
+ @param inputArgsSchema schema for input args taken by this Function]]>
+ </doc>
+ </constructor>
+ <method name="getClassNameFromSpec" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="funcSpec" type="java.lang.String"/>
+ </method>
+ <method name="getArgStringFromSpec" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="funcSpec" type="java.lang.String"/>
+ </method>
+ <method name="parseArguments" return="java.util.List"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="argString" type="java.lang.String"/>
+ <doc>
+ <![CDATA[Function to parse the arguments from a function specification argument list
+ @param argString should be of the form "'arg1', 'arg2', ..."
+ @return List of the different argument strings]]>
+ </doc>
+ </method>
+ <method name="getClassName" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@return the className]]>
+ </doc>
+ </method>
+ <method name="setClassName"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="className" type="java.lang.String"/>
+ <doc>
+ <![CDATA[@param className the className to set]]>
+ </doc>
+ </method>
+ <method name="getCtorArgs" return="java.lang.String[]"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@return the ctorArgs]]>
+ </doc>
+ </method>
+ <method name="setCtorArgs"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="ctorArgs" type="java.lang.String[]"/>
+ <doc>
+ <![CDATA[@param ctorArgs the ctorArgs to set]]>
+ </doc>
+ </method>
+ <method name="toString" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="getInputArgsSchema" return="org.apache.pig.impl.logicalLayer.schema.Schema"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@return the inputArgsSchema]]>
+ </doc>
+ </method>
+ <method name="setInputArgsSchema"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="inputArgsSchema" type="org.apache.pig.impl.logicalLayer.schema.Schema"/>
+ <doc>
+ <![CDATA[@param inputArgsSchema the inputArgsSchema to set]]>
+ </doc>
+ </method>
+ <method name="clone" return="org.apache.pig.FuncSpec"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="CloneNotSupportedException" type="java.lang.CloneNotSupportedException"/>
+ </method>
+ <doc>
+ <![CDATA[Class to represent a UDF specification - essentially
+ encapsulates the class name and the arguments to the constructor]]>
+ </doc>
+ </class>
+ <!-- end class org.apache.pig.FuncSpec -->
+ <!-- start interface org.apache.pig.LoadFunc -->
+ <interface name="LoadFunc" abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <method name="bindTo"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="fileName" type="java.lang.String"/>
+ <param name="is" type="org.apache.pig.impl.io.BufferedPositionedInputStream"/>
+ <param name="offset" type="long"/>
+ <param name="end" type="long"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Specifies a portion of an InputStream to read tuples. Because the
+ starting and ending offsets may not be on record boundaries it is up to
+ the implementor to deal with figuring out the actual starting and ending
+ offsets in such a way that an arbitrarily sliced up file will be processed
+ in its entirety.
+ <p>
+ A common way of handling slices in the middle of records is to start at
+ the given offset and, if the offset is not zero, skip to the end of the
+ first record (which may be a partial record) before reading tuples.
+ Reading continues until a tuple has been read that ends at an offset past
+ the ending offset.
+ <p>
+ <b>The load function should not do any buffering on the input stream</b>. Buffering will
+ cause the offsets returned by is.getPos() to be unreliable.
+
+ @param fileName the name of the file to be read
+ @param is the stream representing the file to be processed, and which can also provide its position.
+ @param offset the offset to start reading tuples.
+ @param end the ending offset for reading.
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="getNext" return="org.apache.pig.data.Tuple"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Retrieves the next tuple to be processed.
+ @return the next tuple to be processed or null if there are no more tuples
+ to be processed.
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="bytesToInteger" return="java.lang.Integer"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="b" type="byte[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Cast data from bytes to integer value.
+ @param b byte array to be cast.
+ @return Integer value.
+ @throws IOException if the value cannot be cast.]]>
+ </doc>
+ </method>
+ <method name="bytesToLong" return="java.lang.Long"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="b" type="byte[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Cast data from bytes to long value.
+ @param b byte array to be cast.
+ @return Long value.
+ @throws IOException if the value cannot be cast.]]>
+ </doc>
+ </method>
+ <method name="bytesToFloat" return="java.lang.Float"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="b" type="byte[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Cast data from bytes to float value.
+ @param b byte array to be cast.
+ @return Float value.
+ @throws IOException if the value cannot be cast.]]>
+ </doc>
+ </method>
+ <method name="bytesToDouble" return="java.lang.Double"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="b" type="byte[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Cast data from bytes to double value.
+ @param b byte array to be cast.
+ @return Double value.
+ @throws IOException if the value cannot be cast.]]>
+ </doc>
+ </method>
+ <method name="bytesToCharArray" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="b" type="byte[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Cast data from bytes to chararray value.
+ @param b byte array to be cast.
+ @return String value.
+ @throws IOException if the value cannot be cast.]]>
+ </doc>
+ </method>
+ <method name="bytesToMap" return="java.util.Map"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="b" type="byte[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Cast data from bytes to map value.
+ @param b byte array to be cast.
+ @return Map value.
+ @throws IOException if the value cannot be cast.]]>
+ </doc>
+ </method>
+ <method name="bytesToTuple" return="org.apache.pig.data.Tuple"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="b" type="byte[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Cast data from bytes to tuple value.
+ @param b byte array to be cast.
+ @return Tuple value.
+ @throws IOException if the value cannot be cast.]]>
+ </doc>
+ </method>
+ <method name="bytesToBag" return="org.apache.pig.data.DataBag"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="b" type="byte[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Cast data from bytes to bag value.
+ @param b byte array to be cast.
+ @return Bag value.
+ @throws IOException if the value cannot be cast.]]>
+ </doc>
+ </method>
+ <method name="fieldsToRead"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="schema" type="org.apache.pig.impl.logicalLayer.schema.Schema"/>
+ <doc>
+ <![CDATA[Indicate to the loader fields that will be needed. This can be useful for
+ loaders that access data that is stored in a columnar format where indicating
+ columns to be accessed a head of time will save scans. If the loader
+ function cannot make use of this information, it is free to ignore it.
+ @param schema Schema indicating which columns will be needed.]]>
+ </doc>
+ </method>
+ <method name="determineSchema" return="org.apache.pig.impl.logicalLayer.schema.Schema"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="fileName" type="java.lang.String"/>
+ <param name="execType" type="org.apache.pig.ExecType"/>
+ <param name="storage" type="org.apache.pig.backend.datastorage.DataStorage"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Find the schema from the loader. This function will be called at parse time
+ (not run time) to see if the loader can provide a schema for the data. The
+ loader may be able to do this if the data is self describing (e.g. JSON). If
+ the loader cannot determine the schema, it can return a null.
+ LoadFunc implementations which need to open the input "fileName", can use
+ FileLocalizer.open(String fileName, ExecType execType, DataStorage storage) to get
+ an InputStream which they can use to initialize their loader implementation. They
+ can then use this to read the input data to discover the schema. Note: this will
+ work only when the fileName represents a file on Local File System or Hadoop file
+ system
+ @param fileName Name of the file to be read.(this will be the same as the filename
+ in the "load statement of the script)
+ @param execType - execution mode of the pig script - one of ExecType.LOCAL or ExecType.MAPREDUCE
+ @param storage - the DataStorage object corresponding to the execType
+ @return a Schema describing the data if possible, or null otherwise.
+ @throws IOException.]]>
+ </doc>
+ </method>
+ <doc>
+ <![CDATA[This interface is used to implement functions to parse records
+ from a dataset. This also includes functions to cast raw byte data into various
+ datatypes. These are external functions because we want loaders, whenever
+ possible, to delay casting of datatypes until the last possible moment (i.e.
+ don't do it on load). This means we need to expose the functionality so that
+ other sections of the code can call back to the loader to do the cast.]]>
+ </doc>
+ </interface>
+ <!-- end interface org.apache.pig.LoadFunc -->
+ <!-- start class org.apache.pig.Main -->
+ <class name="Main" extends="java.lang.Object"
+ abstract="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <constructor name="Main"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </constructor>
+ <method name="main"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="args" type="java.lang.String[]"/>
+ <doc>
+ <![CDATA[The Main-Class for the Pig Jar that will provide a shell and setup a classpath appropriate
+ for executing Jar files.
+
+ @param args
+ -jar can be used to add additional jar files (colon separated). - will start a
+ shell. -e will execute the rest of the command line as if it was input to the
+ shell.
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="usage"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ </class>
+ <!-- end class org.apache.pig.Main -->
+ <!-- start class org.apache.pig.PigException -->
+ <class name="PigException" extends="java.io.IOException"
+ abstract="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <constructor name="PigException"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with null as the error message.]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.Throwable"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified cause.
+
+ @param cause - The cause (which is saved for later retrieval by the <link>Throwable.getCause()</link> method) indicating the source of this exception. A null value is permitted, and indicates that the cause is nonexistent or unknown.]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, java.lang.Throwable"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param cause - The cause (which is saved for later retrieval by the <link>Throwable.getCause()</link> method) indicating the source of this exception. A null value is permitted, and indicates that the cause is nonexistent or unknown.]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, int"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param errCode - The error code shown to the user]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, int, java.lang.Throwable"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param errCode - The error code shown to the user
+ @param cause - The cause (which is saved for later retrieval by the <link>Throwable.getCause()</link> method) indicating the source of this exception. A null value is permitted, and indicates that the cause is nonexistent or unknown.]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, int, byte"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param errCode - The error code shown to the user
+ @param errSrc - The error source]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, int, byte, java.lang.Throwable"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param errCode - The error code shown to the user
+ @param errSrc - The error source
+ @param cause - The cause (which is saved for later retrieval by the <link>Throwable.getCause()</link> method) indicating the source of this exception. A null value is permitted, and indicates that the cause is nonexistent or unknown.]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, int, boolean"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param errCode - The error code shown to the user
+ @param retry - If the exception is retriable or not]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, int, byte, boolean"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param errCode - The error code shown to the user
+ @param errSrc - The error source
+ @param retry - If the exception is retriable or not]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, int, byte, boolean, java.lang.String"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param errCode - The error code shown to the user
+ @param errSrc - The error source
+ @param retry - If the exception is retriable or not
+ @param detailedMsg - The detailed message shown to the developer]]>
+ </doc>
+ </constructor>
+ <constructor name="PigException" type="java.lang.String, int, byte, boolean, java.lang.String, java.lang.Throwable"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Create a new PigException with the specified message, error code, error source, retriable or not, detalied message for the developer and cause.
+
+ @param message - The error message (which is saved for later retrieval by the <link>Throwable.getMessage()</link> method) shown to the user
+ @param errCode - The error code shown to the user
+ @param errSrc - The error source
+ @param retry - If the exception is retriable or not
+ @param detailedMsg - The detailed message shown to the developer
+ @param cause - The cause (which is saved for later retrieval by the <link>Throwable.getCause()</link> method) indicating the source of this exception. A null value is permitted, and indicates that the cause is nonexistent or unknown.]]>
+ </doc>
+ </constructor>
+ <method name="isInput" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="errSource" type="byte"/>
+ <doc>
+ <![CDATA[A static method to query if an error source is due to
+ an input or not.
+
+ @param errSource - byte that indicates the error source
+ @return true if the error source is an input; false otherwise]]>
+ </doc>
+ </method>
+ <method name="isBug" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="errSource" type="byte"/>
+ <doc>
+ <![CDATA[A static method to query if an error source is due to
+ a bug or not.
+
+ @param errSource - byte that indicates the error source
+ @return true if the error source is a bug; false otherwise]]>
+ </doc>
+ </method>
+ <method name="isUserEnvironment" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="errSource" type="byte"/>
+ <doc>
+ <![CDATA[A static method to query if an error source is due to
+ the user environment or not.
+
+ @param errSource - byte that indicates the error source
+ @return true if the error source is due to the user environment; false otherwise]]>
+ </doc>
+ </method>
+ <method name="isRemoteEnvironment" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="errSource" type="byte"/>
+ <doc>
+ <![CDATA[A static method to query if an error source is due to
+ the remote environment or not.
+
+ @param errSource - byte that indicates the error source
+ @return true if the error source is due to the remote environment; false otherwise]]>
+ </doc>
+ </method>
+ <method name="determineErrorSource" return="byte"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="errCode" type="int"/>
+ <doc>
+ <![CDATA[A static method to determine the error source given the error code
+
+ @param errCode - integer error code
+ @return byte that indicates the error source]]>
+ </doc>
+ </method>
+ <method name="retriable" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Checks if the exception is retriable.
+ @return if the exception is retriable or not]]>
+ </doc>
+ </method>
+ <method name="setRetriable"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="retry" type="boolean"/>
+ <doc>
+ <![CDATA[Set the retriable attribute of the exception
+ @param retry - true if retriable; false otherwise]]>
+ </doc>
+ </method>
+ <method name="getErrorSource" return="byte"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Returns the error source of the exception. Can be more than one source.
+ @return error sources represented as a byte]]>
+ </doc>
+ </method>
+ <method name="setErrorSource"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="src" type="byte"/>
+ <doc>
+ <![CDATA[Set the error source of the exception
+ @param src - byte representing the error sources]]>
+ </doc>
+ </method>
+ <method name="getErrorCode" return="int"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Returns the error code of the exception
+ @return error code of the exception]]>
+ </doc>
+ </method>
+ <method name="setErrorCode"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="code" type="int"/>
+ <doc>
+ <![CDATA[Set the error code of the exception
+ @param code - error code]]>
+ </doc>
+ </method>
+ <method name="getDetailedMessage" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Returns the detailed message used by developers for debugging
+ @return detailed message]]>
+ </doc>
+ </method>
+ <method name="setDetailedMessage"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="detailMsg" type="java.lang.String"/>
+ <doc>
+ <![CDATA[Set the detailed message of the exception
+ @param detailMsg - detailed message to be used by developers]]>
+ </doc>
+ </method>
+ <method name="toString" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Returns a short description of this throwable.
+ The result is the concatenation of:
+ <ul>
+ <li> the {@linkplain Class#getName() name} of the class of this object
+ <li> ": " (a colon and a space)
+ <li> "ERROR " (the string ERROR followed by a a space)
+ <li> the result of invoking this object's {@link #getErrorCode} method
+ <li> ": " (a colon and a space)
+ <li> the result of invoking {@link Throwable#getLocalizedMessage() getLocalizedMessage}
+ method
+ </ul>
+ If <tt>getLocalizedMessage</tt> returns <tt>null</tt>, then just
+ the class name is returned.
+
+ @return a string representation of this throwable.]]>
+ </doc>
+ </method>
+ <field name="INPUT" type="byte"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="BUG" type="byte"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="USER_ENVIRONMENT" type="byte"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="REMOTE_ENVIRONMENT" type="byte"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="ERROR" type="byte"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="errorCode" type="int"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ <field name="errorSource" type="byte"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ <field name="retriable" type="boolean"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ <field name="detailedMessage" type="java.lang.String"
+ transient="false" volatile="false"
+ static="false" final="false" visibility="protected"
+ deprecated="not deprecated">
+ </field>
+ <doc>
+ <![CDATA[All exceptions in Pig are encapsulated in the <code>PigException</code>
+ class. Details such as the source of the error, error message, error
+ code, etc. are contained in this class. The default values for the
+ attributes are:
+ errorSource = BUG
+ errorCode = 0
+ retriable = false
+ detailedMessage = null]]>
+ </doc>
+ </class>
+ <!-- end class org.apache.pig.PigException -->
+ <!-- start class org.apache.pig.PigServer -->
+ <class name="PigServer" extends="java.lang.Object"
+ abstract="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <constructor name="PigServer" type="java.lang.String"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="ExecException" type="org.apache.pig.backend.executionengine.ExecException"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </constructor>
+ <constructor name="PigServer" type="org.apache.pig.ExecType"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="ExecException" type="org.apache.pig.backend.executionengine.ExecException"/>
+ </constructor>
+ <constructor name="PigServer" type="org.apache.pig.ExecType, java.util.Properties"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="ExecException" type="org.apache.pig.backend.executionengine.ExecException"/>
+ </constructor>
+ <constructor name="PigServer" type="org.apache.pig.impl.PigContext"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="ExecException" type="org.apache.pig.backend.executionengine.ExecException"/>
+ </constructor>
+ <constructor name="PigServer" type="org.apache.pig.impl.PigContext, boolean"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="ExecException" type="org.apache.pig.backend.executionengine.ExecException"/>
+ </constructor>
+ <method name="parseExecType" return="org.apache.pig.ExecType"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="str" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="getPigContext" return="org.apache.pig.impl.PigContext"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="debugOn"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="debugOff"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="setBatchOn"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Starts batch execution mode.]]>
+ </doc>
+ </method>
+ <method name="isBatchOn" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Retrieve the current execution mode.
+
+ @return true if the execution mode is batch; false otherwise.]]>
+ </doc>
+ </method>
+ <method name="isBatchEmpty" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="FrontendException" type="org.apache.pig.impl.logicalLayer.FrontendException"/>
+ <doc>
+ <![CDATA[Returns whether there is anything to process in the current batch.
+ @throws FrontendException
+ @return true if there are no stores to process in the current
+ batch, false otherwise.]]>
+ </doc>
+ </method>
+ <method name="executeBatch" return="java.util.List"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="FrontendException" type="org.apache.pig.impl.logicalLayer.FrontendException"/>
+ <exception name="ExecException" type="org.apache.pig.backend.executionengine.ExecException"/>
+ <doc>
+ <![CDATA[Submits a batch of Pig commands for execution.
+
+ @throws FrontendException
+ @throws ExecException]]>
+ </doc>
+ </method>
+ <method name="discardBatch"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="FrontendException" type="org.apache.pig.impl.logicalLayer.FrontendException"/>
+ <doc>
+ <![CDATA[Discards a batch of Pig commands.
+
+ @throws FrontendException
+ @throws ExecException]]>
+ </doc>
+ </method>
+ <method name="addPathToSkip"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="path" type="java.lang.String"/>
+ <doc>
+ <![CDATA[Add a path to be skipped while automatically shipping binaries for
+ streaming.
+
+ @param path path to be skipped]]>
+ </doc>
+ </method>
+ <method name="registerFunction"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="function" type="java.lang.String"/>
+ <param name="functionSpec" type="java.lang.String"/>
+ <doc>
+ <![CDATA[Defines an alias for the given function spec. This
+ is useful for functions that require arguments to the
+ constructor.
+
+ @param function - the new function alias to define.
+ @param functionSpec - the name of the function and any arguments.
+ It should have the form: classname('arg1', 'arg2', ...)]]>
+ </doc>
+ </method>
+ <method name="registerFunction"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="function" type="java.lang.String"/>
+ <param name="funcSpec" type="org.apache.pig.FuncSpec"/>
+ <doc>
+ <![CDATA[Defines an alias for the given function spec. This
+ is useful for functions that require arguments to the
+ constructor.
+
+ @param function - the new function alias to define.
+ @param funcSpec - the FuncSpec object representing the name of
+ the function class and any arguments to constructor.]]>
+ </doc>
+ </method>
+ <method name="registerStreamingCommand"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="commandAlias" type="java.lang.String"/>
+ <param name="command" type="org.apache.pig.impl.streaming.StreamingCommand"/>
+ <doc>
+ <![CDATA[Defines an alias for the given streaming command.
+
+ @param commandAlias - the new command alias to define
+ @param command - streaming command to be executed]]>
+ </doc>
+ </method>
+ <method name="registerJar"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="name" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Registers a jar file. Name of the jar file can be an absolute or
+ relative path.
+
+ If multiple resources are found with the specified name, the
+ first one is registered as returned by getSystemResources.
+ A warning is issued to inform the user.
+
+ @param name of the jar file to register
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="registerQuery"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="query" type="java.lang.String"/>
+ <param name="startLine" type="int"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Register a query with the Pig runtime. The query is parsed and registered, but it is not
+ executed until it is needed.
+
+ @param query
+ a Pig Latin expression to be evaluated.
+ @param startLine
+ line number of the query within the whold script
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="clonePlan" return="org.apache.pig.impl.logicalLayer.LogicalPlan"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="alias" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="registerQuery"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="query" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="registerScript"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="fileName" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="printAliases"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="FrontendException" type="org.apache.pig.impl.logicalLayer.FrontendException"/>
+ </method>
+ <method name="dumpSchema" return="org.apache.pig.impl.logicalLayer.schema.Schema"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="alias" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="setJobName"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="name" type="java.lang.String"/>
+ </method>
+ <method name="openIterator" return="java.util.Iterator"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="id" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Forces execution of query (and all queries from which it reads), in order to materialize
+ result]]>
+ </doc>
+ </method>
+ <method name="store" return="org.apache.pig.backend.executionengine.ExecJob"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="id" type="java.lang.String"/>
+ <param name="filename" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Store an alias into a file
+ @param id The alias to store
+ @param filename The file to which to store to
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="store" return="org.apache.pig.backend.executionengine.ExecJob"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="id" type="java.lang.String"/>
+ <param name="filename" type="java.lang.String"/>
+ <param name="func" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[forces execution of query (and all queries from which it reads), in order to store result in file]]>
+ </doc>
+ </method>
+ <method name="explain"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="alias" type="java.lang.String"/>
+ <param name="stream" type="java.io.PrintStream"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Provide information on how a pig query will be executed. For now
+ this information is very developer focussed, and probably not very
+ useful to the average user.
+ @param alias Name of alias to explain.
+ @param stream PrintStream to write explanation to.
+ @throws IOException if the requested alias cannot be found.]]>
+ </doc>
+ </method>
+ <method name="explain"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="alias" type="java.lang.String"/>
+ <param name="format" type="java.lang.String"/>
+ <param name="verbose" type="boolean"/>
+ <param name="markAsExecute" type="boolean"/>
+ <param name="lps" type="java.io.PrintStream"/>
+ <param name="pps" type="java.io.PrintStream"/>
+ <param name="eps" type="java.io.PrintStream"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Provide information on how a pig query will be executed.
+ @param alias Name of alias to explain.
+ @param format Format in which the explain should be printed
+ @param verbose Controls the amount of information printed
+ @param markAsExecute When set will treat the explain like a
+ call to execute in the respoect that all the pending stores are
+ marked as complete.
+ @param lps Stream to print the logical tree
+ @param pps Stream to print the physical tree
+ @param eps Stream to print the execution tree
+ @throws IOException if the requested alias cannot be found.]]>
+ </doc>
+ </method>
+ <method name="capacity" return="long"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Returns the unused byte capacity of an HDFS filesystem. This value does
+ not take into account a replication factor, as that can vary from file
+ to file. Thus if you are using this to determine if you data set will fit
+ in the HDFS, you need to divide the result of this call by your specific replication
+ setting.
+ @return unused byte capacity of the file system.
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="fileSize" return="long"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="filename" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Returns the length of a file in bytes which exists in the HDFS (accounts for replication).
+ @param filename
+ @return length of the file in bytes
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="existsFile" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="filename" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="deleteFile" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="filename" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="renameFile" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="source" type="java.lang.String"/>
+ <param name="target" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="mkdirs" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="dirs" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="listPaths" return="java.lang.String[]"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="dir" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ </method>
+ <method name="totalHadoopTimeSpent" return="long"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="getAliases" return="java.util.Map"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="shutdown"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="getAliasKeySet" return="java.util.Set"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="getExamples" return="java.util.Map"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="alias" type="java.lang.String"/>
+ </method>
+ <doc>
+ <![CDATA[This class is the program's connection to Pig. Typically a program will create a PigServer
+ instance. The programmer then registers queries using registerQuery() and
+ retrieves results using openIterator() or store().]]>
+ </doc>
+ </class>
+ <!-- end class org.apache.pig.PigServer -->
+ <!-- start class org.apache.pig.PigWarning -->
+ <class name="PigWarning" extends="java.lang.Enum"
+ abstract="false"
+ static="false" final="true" visibility="public"
+ deprecated="not deprecated">
+ <method name="values" return="org.apache.pig.PigWarning[]"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <method name="valueOf" return="org.apache.pig.PigWarning"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="name" type="java.lang.String"/>
+ </method>
+ <field name="ACCESSING_NON_EXISTENT_FIELD" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="DID_NOT_FIND_LOAD_ONLY_MAP_PLAN" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="DIVIDE_BY_ZERO" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="FIELD_DISCARDED_TYPE_CONVERSION_FAILED" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="GROUP_BY_INCOMPATIBLE_TYPES" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="IMPLICIT_CAST_TO_BAG" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="IMPLICIT_CAST_TO_CHARARRAY" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="IMPLICIT_CAST_TO_DOUBLE" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="IMPLICIT_CAST_TO_FLOAT" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="IMPLICIT_CAST_TO_INT" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="IMPLICIT_CAST_TO_LONG" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="IMPLICIT_CAST_TO_MAP" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="IMPLICIT_CAST_TO_TUPLE" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="TOO_LARGE_FOR_INT" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="MULTI_LEAF_MAP" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="MULTI_LEAF_REDUCE" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="NON_PACKAGE_REDUCE_PLAN_ROOT" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="NON_EMPTY_COMBINE_PLAN" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="PROGRESS_REPORTER_NOT_PROVIDED" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="REDUCE_PLAN_NOT_EMPTY_WHILE_MAP_PLAN_UNDER_PROCESS" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_1" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_2" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_3" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_4" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_5" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_6" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_7" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_8" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_9" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_10" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_11" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UDF_WARNING_12" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UNABLE_TO_CREATE_FILE_TO_SPILL" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UNABLE_TO_SPILL" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UNABLE_TO_CLOSE_SPILL_FILE" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="UNREACHABLE_CODE_BOTH_MAP_AND_REDUCE_PLANS_PROCESSED" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <field name="USING_OVERLOADED_FUNCTION" type="org.apache.pig.PigWarning"
+ transient="false" volatile="false"
+ static="true" final="true" visibility="public"
+ deprecated="not deprecated">
+ </field>
+ <doc>
+ <![CDATA[An enum to enumerate the warning types in Pig]]>
+ </doc>
+ </class>
+ <!-- end class org.apache.pig.PigWarning -->
+ <!-- start interface org.apache.pig.ReversibleLoadStoreFunc -->
+ <interface name="ReversibleLoadStoreFunc" abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <implements name="org.apache.pig.LoadFunc"/>
+ <implements name="org.apache.pig.StoreFunc"/>
+ <doc>
+ <![CDATA[This interface is used to implement classes that can perform both
+ Load and Store functionalities in a symmetric fashion (thus reversible).
+
+ The symmetry property of implementations is used in the optimization
+ engine therefore violation of this property while implementing this
+ interface is likely to result in unexpected output from executions.]]>
+ </doc>
+ </interface>
+ <!-- end interface org.apache.pig.ReversibleLoadStoreFunc -->
+ <!-- start interface org.apache.pig.Slice -->
+ <interface name="Slice" abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <implements name="java.io.Serializable"/>
+ <method name="getLocations" return="java.lang.String[]"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Returns string representations of all the files that will be used as part
+ of processing this Slice.
+ <p>
+
+ This is the only method on Slice that is valid to call before
+ {@link #init(DataStorage)} has been called.]]>
+ </doc>
+ </method>
+ <method name="init"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="store" type="org.apache.pig.backend.datastorage.DataStorage"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Initializes this Slice with the DataStorage it's to use to do its work.
+ <p>
+ This will always be called before <code>getLength</code>,
+ <code>close</code>, <code>getPos</code>, <code>getProgress</code>
+ and <code>next</code>.]]>
+ </doc>
+ </method>
+ <method name="getStart" return="long"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Returns the offset from which data in this Slice will be processed.]]>
+ </doc>
+ </method>
+ <method name="getLength" return="long"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[Returns the length in bytes of all of the data that will be processed by
+ this Slice.
+ <p>
+ Only valid to call after {@link #init(DataStorage)} has been called.]]>
+ </doc>
+ </method>
+ <method name="close"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Closes any streams this Slice has opened as part of its work.
+ <p>
+ Only valid to call after {@link #init(DataStorage)} has been called.]]>
+ </doc>
+ </method>
+ <method name="getPos" return="long"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Returns the number of bytes read so far as part of processing this Slice.
+ <p>
+ Only valid to call after {@link #init(DataStorage)} has been called.]]>
+ </doc>
+ </method>
+ <method name="getProgress" return="float"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Returns the percentage of Slice that is complete from 0.0 to 1.0.
+ <p>
+ Only valid to call after {@link #init(DataStorage)} has been called.]]>
+ </doc>
+ </method>
+ <method name="next" return="boolean"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="value" type="org.apache.pig.data.Tuple"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Loads the next value from this Slice into <code>value</code>.
+ <p>
+ Only valid to call after {@link #init(DataStorage)} has been called.
+
+ @param value -
+ the Tuple to be filled with the next value.
+ @return - true if there are more Tuples to be read.]]>
+ </doc>
+ </method>
+ <doc>
+ <![CDATA[A grouping of data on that can be processed individually by Pig. Instances of
+ this interface are created by {@link Slicer}, serialized, and sent to nodes
+ to be processed.
+ <p>
+ {@link #getLocations} is called as part of the configuration process to
+ determine where this Slice should be run for maximal locality with the data
+ to be read. Once the Slice arrives on the processing node,
+ {@link #init(DataStorage)} is called to give it access to the
+ <code>DataStorage</code> it should use to load Tuples. After
+ <code>init</code> has been called, any of the other methods on this
+ interface may be called as part of Pig's processing.]]>
+ </doc>
+ </interface>
+ <!-- end interface org.apache.pig.Slice -->
+ <!-- start interface org.apache.pig.Slicer -->
+ <interface name="Slicer" abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <method name="validate"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="store" type="org.apache.pig.backend.datastorage.DataStorage"/>
+ <param name="location" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Checks that <code>location</code> is parsable by this Slicer, and that
+ if the DataStorage is used by the Slicer, it's readable from there. If it
+ isn't, an IOException with a message explaining why will be thrown.
+ <p>
+ This does not ensure that all the data in <code>location</code> is
+ valid. It's a preflight check that there's some chance of the Slicer
+ working before actual Slices are created and sent off for processing.]]>
+ </doc>
+ </method>
+ <method name="slice" return="org.apache.pig.Slice[]"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="store" type="org.apache.pig.backend.datastorage.DataStorage"/>
+ <param name="location" type="java.lang.String"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Creates slices of data from <code>store</code> at <code>location</code>.
+
+ @return the Slices to be serialized and sent out to nodes for processing.]]>
+ </doc>
+ </method>
+ <doc>
+ <![CDATA[Produces independent slices of data from a given location to be processed in
+ parallel by Pig.
+ <p>
+ If a class implementing this interface is given as the LoadFunc in a Pig
+ script, it will be used to make slices for that load statement.]]>
+ </doc>
+ </interface>
+ <!-- end interface org.apache.pig.Slicer -->
+ <!-- start class org.apache.pig.StandAloneParser -->
+ <class name="StandAloneParser" extends="java.lang.Object"
+ abstract="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <constructor name="StandAloneParser"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </constructor>
+ <method name="main"
+ abstract="false" native="false" synchronized="false"
+ static="true" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="args" type="java.lang.String[]"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <exception name="ExecException" type="org.apache.pig.backend.executionengine.ExecException"/>
+ </method>
+ </class>
+ <!-- end class org.apache.pig.StandAloneParser -->
+ <!-- start class org.apache.pig.StoreConfig -->
+ <class name="StoreConfig" extends="java.lang.Object"
+ abstract="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <implements name="java.io.Serializable"/>
+ <constructor name="StoreConfig" type="java.lang.String, org.apache.pig.impl.logicalLayer.schema.Schema"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@param location
+ @param schema]]>
+ </doc>
+ </constructor>
+ <method name="getLocation" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@return the location]]>
+ </doc>
+ </method>
+ <method name="setLocation"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="location" type="java.lang.String"/>
+ <doc>
+ <![CDATA[@param location the location to set]]>
+ </doc>
+ </method>
+ <method name="getSchema" return="org.apache.pig.impl.logicalLayer.schema.Schema"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <doc>
+ <![CDATA[@return the schema]]>
+ </doc>
+ </method>
+ <method name="setSchema"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="schema" type="org.apache.pig.impl.logicalLayer.schema.Schema"/>
+ <doc>
+ <![CDATA[@param schema the schema to set]]>
+ </doc>
+ </method>
+ <method name="toString" return="java.lang.String"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ </method>
+ <doc>
+ <![CDATA[A Class which will encapsulate metadata information that a
+ OutputFormat (or possibly StoreFunc) may want to know
+ about the data that needs to be stored.]]>
+ </doc>
+ </class>
+ <!-- end class org.apache.pig.StoreConfig -->
+ <!-- start interface org.apache.pig.StoreFunc -->
+ <interface name="StoreFunc" abstract="true"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <method name="bindTo"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="os" type="java.io.OutputStream"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Specifies the OutputStream to write to. This will be called before
+ store(Tuple) is invoked.
+
+ @param os The stream to write tuples to.
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="putNext"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <param name="f" type="org.apache.pig.data.Tuple"/>
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Write a tuple the output stream to which this instance was
+ previously bound.
+
+ @param f the tuple to store.
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="finish"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
+ <exception name="IOException" type="java.io.IOException"/>
+ <doc>
+ <![CDATA[Do any kind of post processing because the last tuple has been
+ stored. DO NOT CLOSE THE STREAM in this method. The stream will be
+ closed later outside of this function.
+
+ @throws IOException]]>
+ </doc>
+ </method>
+ <method name="getStorePreparationClass" return="java.lang.Class"
+ abstract="false" native="false" synchronized="false"
+ static="false" final="false" visibility="public"
+ deprecated="not deprecated">
[... 35205 lines stripped ...]