Added: pig/trunk/src/docs/jdiff/pig_0.17.0.xml URL: http://svn.apache.org/viewvc/pig/trunk/src/docs/jdiff/pig_0.17.0.xml?rev=1799414&view=auto ============================================================================== --- pig/trunk/src/docs/jdiff/pig_0.17.0.xml (added) +++ pig/trunk/src/docs/jdiff/pig_0.17.0.xml Wed Jun 21 09:29:16 2017 @@ -0,0 +1,93183 @@ +<?xml version="1.0" encoding="iso-8859-1" standalone="no"?> +<!-- Generated by the JDiff Javadoc doclet --> +<!-- (http://www.jdiff.org) --> +<!-- on Tue Jun 20 13:45:27 CEST 2017 --> + +<api + xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance' + xsi:noNamespaceSchemaLocation='api.xsd' + name="pig 0.17.0" + jdversion="1.0.9"> + +<!-- Command line arguments = -doclet jdiff.JDiff -docletpath /Users/szita/shadow/apache/pig/17RC/build/ivy/lib/Pig/jdiff-1.0.9.jar:/Users/szita/shadow/apache/pig/17RC/build/ivy/lib/Pig/xercesImpl-2.10.0.jar -classpath /Users/szita/.ivy2/cache/xmlenc/xmlenc/jars/xmlenc-0.52.jar:/Users/szita/.ivy2/cache/com.sun.jersey/jersey-bundle/jars/jersey-bundle-1.8.jar:/Users/szita/.ivy2/cache/com.sun.jersey/jersey-server/bundles/jersey-server-1.8.jar:/Users/szita/.ivy2/cache/com.sun.jersey.contribs/jersey-guice/jars/jersey-guice-1.8.jar:/Users/szita/.ivy2/cache/commons-codec/commons-codec/jars/commons-codec-1.4.jar:/Users/szita/.ivy2/cache/commons-httpclient/commons-httpclient/jars/commons-httpclient-3.1.jar:/Users/szita/.ivy2/cache/commons-configuration/commons-configuration/jars/commons-configuration-1.6.jar:/Users/szita/.ivy2/cache/commons-collections/commons-collections/jars/commons-collections-3.2.1.jar:/Users/szita/.ivy2/cache/javax.servlet/servlet-api/jars/servlet-api-2.5.jar:/Users/s zita/.ivy2/cache/javax.ws.rs/jsr311-api/jars/jsr311-api-1.1.1.jar:/Users/szita/.ivy2/cache/com.google.protobuf/protobuf-java/bundles/protobuf-java-2.5.0.jar:/Users/szita/.ivy2/cache/javax.inject/javax.inject/jars/javax.inject-1.jar:/Users/szita/.ivy2/cache/javax.xml.bind/jaxb-api/jars/jaxb-api-2.2.2.jar:/Users/szita/.ivy2/cache/com.sun.xml.bind/jaxb-impl/jars/jaxb-impl-2.2.3-1.jar:/Users/szita/.ivy2/cache/com.google.inject/guice/jars/guice-3.0.jar:/Users/szita/.ivy2/cache/com.google.inject.extensions/guice-servlet/jars/guice-servlet-3.0.jar:/Users/szita/.ivy2/cache/aopalliance/aopalliance/jars/aopalliance-1.0.jar:/Users/szita/.ivy2/cache/org.mortbay.jetty/jsp-2.1/jars/jsp-2.1-6.1.14.jar:/Users/szita/.ivy2/cache/org.mortbay.jetty/jsp-api-2.1/jars/jsp-api-2.1-6.1.14.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-annotations/jars/hadoop-annotations-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-auth/jars/hadoop-auth-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hado op/hadoop-common/testss/hadoop-common-2.7.3-tests.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-common/jars/hadoop-common-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-hdfs/testss/hadoop-hdfs-2.7.3-tests.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-hdfs/jars/hadoop-hdfs-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-mapreduce-client-core/jars/hadoop-mapreduce-client-core-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-mapreduce-client-jobclient/testss/hadoop-mapreduce-client-jobclient-2.7.3-tests.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-mapreduce-client-jobclient/jars/hadoop-mapreduce-client-jobclient-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-server-tests/jars/hadoop-yarn-server-tests-2.7.3-tests.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-mapreduce-client-app/jars/hadoop-mapreduce-client-app-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-mapreduce-client-shuffle/jars/h adoop-mapreduce-client-shuffle-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-mapreduce-client-common/jars/hadoop-mapreduce-client-common-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-api/jars/hadoop-yarn-api-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-common/jars/hadoop-yarn-common-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-server-web-proxy/jars/hadoop-yarn-server-web-proxy-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-server-common/jars/hadoop-yarn-server-common-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-server-nodemanager/jars/hadoop-yarn-server-nodemanager-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-server-resourcemanager/jars/hadoop-yarn-server-resourcemanager-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-client/jars/hadoop-yarn-client-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-yarn-server-applicationhistory service/jars/hadoop-yarn-server-applicationhistoryservice-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.hadoop/hadoop-mapreduce-client-hs/jars/hadoop-mapreduce-client-hs-2.7.3.jar:/Users/szita/.ivy2/cache/org.apache.avro/avro-mapred/jars/avro-mapred-1.7.5-hadoop2.jar:/Users/szita/.ivy2/cache/org.apache.avro/avro-ipc/jars/avro-ipc-1.7.5-tests.jar:/Users/szita/.ivy2/cache/org.apache.avro/avro/jars/avro-1.7.5.jar:/Users/szita/.ivy2/cache/com.thoughtworks.paranamer/paranamer/jars/paranamer-2.3.jar:/Users/szita/.ivy2/cache/org.apache.commons/commons-compress/jars/commons-compress-1.4.1.jar:/Users/szita/.ivy2/cache/org.tukaani/xz/jars/xz-1.0.jar:/Users/szita/.ivy2/cache/org.slf4j/slf4j-api/jars/slf4j-api-1.6.4.jar:/Users/szita/.ivy2/cache/org.mortbay.jetty/jetty/jars/jetty-6.1.26.jar:/Users/szita/.ivy2/cache/org.mortbay.jetty/jetty-util/jars/jetty-util-6.1.26.jar:/Users/szita/.ivy2/cache/org.mortbay.jetty/servlet-api/jars/servlet-api-2.5-20081211.jar:/Users/szita/.ivy2/cache/org.apache.ve locity/velocity/jars/velocity-1.7.jar:/Users/szita/.ivy2/cache/commons-lang/commons-lang/jars/commons-lang-2.4.jar:/Users/szita/.ivy2/cache/org.htrace/htrace-core/jars/htrace-core-3.0.4.jar:/Users/szita/.ivy2/cache/org.apache.htrace/htrace-core/jars/htrace-core-3.1.0-incubating.jar:/Users/szita/.ivy2/cache/org.fusesource.leveldbjni/leveldbjni-all/bundles/leveldbjni-all-1.8.jar:/Users/szita/.ivy2/cache/org.apache.hive.shims/hive-shims-0.23/jars/hive-shims-0.23-1.2.1.jar:/Users/szita/.ivy2/cache/org.apache.tez/tez-common/jars/tez-common-0.7.0.jar:/Users/szita/.ivy2/cache/org.apache.tez/tez-api/jars/tez-api-0.7.0.jar:/Users/szita/.ivy2/cache/org.apache.tez/tez-dag/jars/tez-dag-0.7.0.jar:/Users/szita/.ivy2/cache/org.apache.tez/tez-runtime-internals/jars/tez-runtime-internals-0.7.0.jar:/Users/szita/.ivy2/cache/org.apache.tez/tez-runtime-library/jars/tez-runtime-library-0.7.0.jar:/Users/szita/.ivy2/cache/org.apache.tez/tez-mapreduce/jars/tez-mapreduce-0.7.0.jar:/Users/szita/.ivy2/cache/or g.apache.tez/tez-yarn-timeline-history-with-acls/jars/tez-yarn-timeline-history-with-acls-0.7.0.jar:/Users/szita/.ivy2/cache/org.apache.commons/commons-collections4/jars/commons-collections4-4.0.jar:/Users/szita/.ivy2/cache/org.codehaus.jettison/jettison/bundles/jettison-1.3.4.jar:/Users/szita/.ivy2/cache/org.apache.commons/commons-math3/jars/commons-math3-3.1.1.jar:/Users/szita/.ivy2/cache/org.apache.curator/curator-framework/bundles/curator-framework-2.6.0.jar:/Users/szita/.ivy2/cache/org.apache.curator/curator-client/bundles/curator-client-2.6.0.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-client/test-jars/hbase-client-1.2.4-tests.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-client/jars/hbase-client-1.2.4.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-common/jars/hbase-common-1.2.4.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-common/test-jars/hbase-common-1.2.4-tests.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-server/test-jars/hbase-server-1.2.4- tests.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-server/jars/hbase-server-1.2.4.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-protocol/jars/hbase-protocol-1.2.4.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-protocol/test-jars/hbase-protocol-1.2.4-tests.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-hadoop-compat/test-jars/hbase-hadoop-compat-1.2.4-tests.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-hadoop-compat/jars/hbase-hadoop-compat-1.2.4.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-hadoop2-compat/jars/hbase-hadoop2-compat-1.2.4.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-hadoop2-compat/test-jars/hbase-hadoop2-compat-1.2.4-tests.jar:/Users/szita/.ivy2/cache/org.cloudera.htrace/htrace-core/jars/htrace-core-2.00.jar:/Users/szita/.ivy2/cache/com.lmax/disruptor/jars/disruptor-3.3.0.jar:/Users/szita/.ivy2/cache/commons-el/commons-el/jars/commons-el-1.0.jar:/Users/szita/.ivy2/cache/commons-io/commons-io/jars/commons-io-2.3.jar:/Users/szit a/.ivy2/cache/nl.basjes.parse.httpdlog/httpdlog-pigloader/jars/httpdlog-pigloader-2.4.jar:/Users/szita/.ivy2/cache/nl.basjes.parse.httpdlog/httpdlog-inputformat/jars/httpdlog-inputformat-2.4.jar:/Users/szita/.ivy2/cache/nl.basjes.parse.httpdlog/httpdlog-parser/jars/httpdlog-parser-2.4.jar:/Users/szita/.ivy2/cache/nl.basjes.parse/parser-core/jars/parser-core-2.4.jar:/Users/szita/.ivy2/cache/log4j/log4j/bundles/log4j-1.2.16.jar:/Users/szita/.ivy2/cache/commons-logging/commons-logging/jars/commons-logging-1.1.1.jar:/Users/szita/.ivy2/cache/org.slf4j/slf4j-log4j12/jars/slf4j-log4j12-1.6.1.jar:/Users/szita/.ivy2/cache/commons-cli/commons-cli/jars/commons-cli-1.2.jar:/Users/szita/.ivy2/cache/org.apache.avro/trevni-core/test-jars/trevni-core-1.7.5-tests.jar:/Users/szita/.ivy2/cache/org.apache.avro/trevni-core/jars/trevni-core-1.7.5.jar:/Users/szita/.ivy2/cache/org.apache.avro/trevni-avro/test-jars/trevni-avro-1.7.5-tests.jar:/Users/szita/.ivy2/cache/org.apache.avro/trevni-avro/jars/trevni- avro-1.7.5.jar:/Users/szita/.ivy2/cache/org.xerial.snappy/snappy-java/bundles/snappy-java-1.1.1.3.jar:/Users/szita/.ivy2/cache/com.googlecode.json-simple/json-simple/jars/json-simple-1.1.jar:/Users/szita/.ivy2/cache/jline/jline/jars/jline-2.11.jar:/Users/szita/.ivy2/cache/net.java.dev.javacc/javacc/jars/javacc-4.2.jar:/Users/szita/.ivy2/cache/org.codehaus.groovy/groovy-all/jars/groovy-all-2.4.5.jar:/Users/szita/.ivy2/cache/org.apache.ivy/ivy/jars/ivy-2.2.0.jar:/Users/szita/.ivy2/cache/org.codehaus.jackson/jackson-mapper-asl/jars/jackson-mapper-asl-1.9.13.jar:/Users/szita/.ivy2/cache/org.codehaus.jackson/jackson-core-asl/jars/jackson-core-asl-1.9.13.jar:/Users/szita/.ivy2/cache/org.fusesource.jansi/jansi/jars/jansi-1.9.jar:/Users/szita/.ivy2/cache/joda-time/joda-time/jars/joda-time-2.9.3.jar:/Users/szita/.ivy2/cache/com.google.guava/guava/jars/guava-11.0.jar:/Users/szita/.ivy2/cache/org.python/jython-standalone/jars/jython-standalone-2.7.0.jar:/Users/szita/.ivy2/cache/rhino/js/jars/j s-1.7R2.jar:/Users/szita/.ivy2/cache/org.antlr/antlr/jars/antlr-3.4.jar:/Users/szita/.ivy2/cache/org.antlr/antlr-runtime/jars/antlr-runtime-3.4.jar:/Users/szita/.ivy2/cache/org.antlr/stringtemplate/jars/stringtemplate-3.2.1.jar:/Users/szita/.ivy2/cache/antlr/antlr/jars/antlr-2.7.7.jar:/Users/szita/.ivy2/cache/org.antlr/ST4/jars/ST4-4.0.4.jar:/Users/szita/.ivy2/cache/org.apache.zookeeper/zookeeper/jars/zookeeper-3.4.5.jar:/Users/szita/.ivy2/cache/dk.brics.automaton/automaton/jars/automaton-1.11-8.jar:/Users/szita/.ivy2/cache/org.jruby/jruby-complete/bundles/jruby-complete-1.7.26.jar:/Users/szita/.ivy2/cache/asm/asm/jars/asm-3.3.1.jar:/Users/szita/.ivy2/cache/org.apache.accumulo/accumulo-core/jars/accumulo-core-1.5.0.jar:/Users/szita/.ivy2/cache/com.beust/jcommander/jars/jcommander-1.30.jar:/Users/szita/.ivy2/cache/org.apache.accumulo/accumulo-fate/jars/accumulo-fate-1.5.0.jar:/Users/szita/.ivy2/cache/org.apache.accumulo/accumulo-start/jars/accumulo-start-1.5.0.jar:/Users/szita/.ivy2/ cache/org.apache.commons/commons-vfs2/jars/commons-vfs2-2.0.jar:/Users/szita/.ivy2/cache/org.apache.maven.scm/maven-scm-api/jars/maven-scm-api-1.4.jar:/Users/szita/.ivy2/cache/org.codehaus.plexus/plexus-utils/jars/plexus-utils-1.5.6.jar:/Users/szita/.ivy2/cache/org.apache.maven.scm/maven-scm-provider-svnexe/jars/maven-scm-provider-svnexe-1.4.jar:/Users/szita/.ivy2/cache/org.apache.maven.scm/maven-scm-provider-svn-commons/jars/maven-scm-provider-svn-commons-1.4.jar:/Users/szita/.ivy2/cache/regexp/regexp/jars/regexp-1.3.jar:/Users/szita/.ivy2/cache/org.apache.accumulo/accumulo-trace/jars/accumulo-trace-1.5.0.jar:/Users/szita/.ivy2/cache/org.apache.thrift/libthrift/jars/libthrift-0.9.0.jar:/Users/szita/.ivy2/cache/org.apache.httpcomponents/httpclient/jars/httpclient-4.1.3.jar:/Users/szita/.ivy2/cache/org.apache.httpcomponents/httpcore/jars/httpcore-4.1.3.jar:/Users/szita/.ivy2/cache/org.apache.accumulo/accumulo-minicluster/jars/accumulo-minicluster-1.5.0.jar:/Users/szita/.ivy2/cache/or g.apache.accumulo/accumulo-server/jars/accumulo-server-1.5.0.jar:/Users/szita/.ivy2/cache/com.google.code.gson/gson/jars/gson-2.2.2.jar:/Users/szita/.ivy2/cache/org.apache.hive/hive-exec/jars/hive-exec-1.2.1-core.jar:/Users/szita/.ivy2/cache/org.apache.hive/hive-serde/jars/hive-serde-1.2.1.jar:/Users/szita/.ivy2/cache/org.apache.hive/hive-common/jars/hive-common-1.2.1.jar:/Users/szita/.ivy2/cache/org.apache.hive.shims/hive-shims-common/jars/hive-shims-common-1.2.1.jar:/Users/szita/.ivy2/cache/com.esotericsoftware.kryo/kryo/bundles/kryo-2.22.jar:/Users/szita/.ivy2/cache/org.apache.commons/commons-lang3/jars/commons-lang3-3.1.jar:/Users/szita/.ivy2/cache/org.vafer/jdeb/maven-plugins/jdeb-0.8.jar:/Users/szita/.ivy2/cache/com.twitter/parquet-pig-bundle/jars/parquet-pig-bundle-1.2.3.jar:/Users/szita/.ivy2/cache/org.apache.avro/avro-tools/jars/avro-tools-1.7.5-nodeps.jar:/Users/szita/.ivy2/cache/net.sf.jopt-simple/jopt-simple/jars/jopt-simple-4.1.jar:/Users/szita/.ivy2/cache/xalan/xalan/j ars/xalan-2.7.1.jar:/Users/szita/.ivy2/cache/xalan/serializer/jars/serializer-2.7.1.jar:/Users/szita/.ivy2/cache/xerces/xercesImpl/jars/xercesImpl-2.10.0.jar:/Users/szita/.ivy2/cache/xml-apis/xml-apis/jars/xml-apis-1.4.01.jar:/Users/szita/.ivy2/cache/junit/junit/jars/junit-4.11.jar:/Users/szita/.ivy2/cache/io.netty/netty/bundles/netty-3.6.6.Final.jar:/Users/szita/.ivy2/cache/io.netty/netty-all/jars/netty-all-4.0.23.Final.jar:/Users/szita/.ivy2/cache/org.apache.hbase/hbase-procedure/jars/hbase-procedure-1.2.4.jar:/Users/szita/.ivy2/cache/com.yammer.metrics/metrics-core/jars/metrics-core-2.1.2.jar:/Users/szita/.ivy2/cache/hsqldb/hsqldb/jars/hsqldb-1.8.0.10.jar:/Users/szita/.ivy2/cache/org.apache.hive/hive-contrib/jars/hive-contrib-1.2.1.jar:/Users/szita/.ivy2/cache/org.iq80.snappy/snappy/jars/snappy-0.2.jar:/Users/szita/.ivy2/cache/org.mockito/mockito-all/jars/mockito-all-1.8.4.jar:/Users/szita/shadow/apache/pig/17RC/build/pig-0.17.0.jar -sourcepath /Users/szita/shadow/apache/pig/17RC /src -doclet jdiff.JDiff -docletpath /Users/szita/shadow/apache/pig/17RC/build/ivy/lib/Pig/jdiff-1.0.9.jar:/Users/szita/shadow/apache/pig/17RC/build/ivy/lib/Pig/xercesImpl-2.10.0.jar -apidir /Users/szita/shadow/apache/pig/17RC/src/docs/jdiff -apiname pig 0.17.0 --> +<package name="org.apache.pig"> + <!-- start interface org.apache.pig.Accumulator --> + <interface name="Accumulator" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <method name="accumulate" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="b" type="org.apache.pig.data.Tuple"/> + <exception name="IOException" type="java.io.IOException"/> + <doc> + <![CDATA[Pass tuples to the UDF. + @param b A tuple containing a single field, which is a bag. The bag will contain the set + of tuples being passed to the UDF in this iteration.]]> + </doc> + </method> + <method name="getValue" return="java.lang.Object" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Called when all tuples from current key have been passed to accumulate. + @return the value for the UDF for this key.]]> + </doc> + </method> + <method name="cleanup" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Called after getValue() to prepare processing for next key.]]> + </doc> + </method> + <doc> + <![CDATA[An interface that allows UDFs that take a bag to accumulate tuples in chunks rather than take + the whole set at once. This is intended for UDFs that do not need to see all of the tuples + together but cannot be used with the combiner. This lowers the memory needs, avoiding the need + to spill large bags, and thus speeds up the query. An example is something like session analysis. + It cannot be used with the combiner because all it's inputs must first be ordered. But it does + not need to see all the tuples at once. UDF implementors might also choose to implement this + interface so that if other UDFs in the FOREACH implement it it can be used. + @since Pig 0.6]]> + </doc> + </interface> + <!-- end interface org.apache.pig.Accumulator --> + <!-- start class org.apache.pig.AccumulatorEvalFunc --> + <class name="AccumulatorEvalFunc" extends="org.apache.pig.EvalFunc" + abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="org.apache.pig.Accumulator"/> + <constructor name="AccumulatorEvalFunc" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="accumulate" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="b" type="org.apache.pig.data.Tuple"/> + <exception name="IOException" type="java.io.IOException"/> + </method> + <method name="cleanup" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="getValue" return="java.lang.Object" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="exec" return="java.lang.Object" + abstract="false" 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"/> + </method> + <doc> + <![CDATA[This class is used to provide a free implementation of the EvalFunc exec function given + implementation of the Accumulator interface. Instead of having to provide a redundant + implementation, this provides the base exec function for free, given that the methods + associated with the Accumulator interface are implemented. For information on how to + implement Accumulator, see {@link Accumulator}.]]> + </doc> + </class> + <!-- end class org.apache.pig.AccumulatorEvalFunc --> + <!-- 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="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Get the initial function. + @return A function name of f_init. f_init should be an eval func. + The return type of f_init.exec() has to be Tuple]]> + </doc> + </method> + <method name="getIntermed" return="java.lang.String" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Get the intermediate function. + @return A function name of f_intermed. f_intermed should be an eval func. + The return type of f_intermed.exec() has to be Tuple]]> + </doc> + </method> + <method name="getFinal" return="java.lang.String" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Get the final function. + @return A function name of 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, Pig will attempt to use MapReduce's combiner. + The initial funciton will be called in the map phase and be passed a single tuple. The + intermediate function will be called 0 or more times in the combiner phase. And the final + function will be called once in the reduce phase. It is important that the results be the same + whether the intermediate function is called 0, 1, or more times. Hadoop makes no guarantees + about how many times the combiner will be called in a job.]]> + </doc> + </interface> + <!-- end interface org.apache.pig.Algebraic --> + <!-- start class org.apache.pig.AlgebraicEvalFunc --> + <class name="AlgebraicEvalFunc" extends="org.apache.pig.AccumulatorEvalFunc" + abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="org.apache.pig.Algebraic"/> + <constructor name="AlgebraicEvalFunc" type="java.lang.String[]" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[It is key that if a subclass has a constructor, that it calls super(args...) or else + this class will not instantiate properly.]]> + </doc> + </constructor> + <method name="getFinal" return="java.lang.String" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[This must be implement as per a normal Algebraic interface. See {@link Algebraic} for + more information.]]> + </doc> + </method> + <method name="getInitial" return="java.lang.String" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[This must be implement as per a normal Algebraic interface. See {@link Algebraic} for + more information.]]> + </doc> + </method> + <method name="getIntermed" return="java.lang.String" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[This must be implement as per a normal Algebraic interface. See {@link Algebraic} for + more information.]]> + </doc> + </method> + <method name="accumulate" + abstract="false" 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 is the free accumulate implementation based on the static classes provided + by the Algebraic static classes. This implemention works by leveraging the + initial, intermediate, and final classes provided by the algebraic interface. + The exec function of the Initial EvalFunc will be called on every Tuple of the input + and the output will be collected in an intermediate state. Periodically, this intermediate + state will have the Intermediate EvalFunc called on it 1 or more times. The Final EvalFunc + is not called until getValue() is called.]]> + </doc> + </method> + <method name="cleanup" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Per the Accumulator interface, this clears all of the variables used in the implementation.]]> + </doc> + </method> + <method name="getValue" return="java.lang.Object" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[This function returns the ultimate result. It is when getValue() is called that + the Final EvalFunc's exec function is called on the accumulated data.]]> + </doc> + </method> + <doc> + <![CDATA[This class is used to provide a free implementation of the Accumulator interface + and EvalFunc class in the case of an Algebraic function. Instead of having to provide + redundant implementations for Accumulator and EvalFunc, implementing the + getInitial, getIntermed, and getFinal methods (which implies implementing the static classes + they reference) will give you an implementation of each of those for free. <br><br> + One key thing to note is that if a subclass of AlgebraicEvalFunc wishes to use any constructor + arguments, it MUST call super(args). + <br><br> + IMPORTANT: the implementation of the Accumulator interface that this class provides is good, + but it is simulated. For maximum efficiency, it is important to manually implement the accumulator + interface. See {@link Accumulator} for more information on how to do so.]]> + </doc> + </class> + <!-- end class org.apache.pig.AlgebraicEvalFunc --> + <!-- start interface org.apache.pig.CollectableLoadFunc --> + <interface name="CollectableLoadFunc" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <method name="ensureAllKeyInstancesInSameSplit" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <exception name="IOException" type="java.io.IOException"/> + <doc> + <![CDATA[When this method is called, Pig is communicating to the Loader that it must + load data such that all instances of a key are in same split. Pig will + make no further checks at runtime to ensure whether the contract is honored + or not. + @throws IOException]]> + </doc> + </method> + <doc> + <![CDATA[This interface implemented by a {@link LoadFunc} implementations indicates to + Pig that it has the capability to load data such that all instances of a key + will occur in same split. + @since Pig 0.7]]> + </doc> + </interface> + <!-- end interface org.apache.pig.CollectableLoadFunc --> + <!-- 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"/> + <doc> + <![CDATA[Compare two tuples. Note that even though both args are given type of + WritableComparable to match the WritableComparable interface, they + must both be tuples. + @param a first tuple + @param b tuple to compare a to + @return -1 if a < b, 1 if a > b, 0 if a = b]]> + </doc> + </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. 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. + @return Returns a negative integer, zero, or a positive integer as the first + argument is less than, equal to, or greater than the second. + @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"/> + <doc> + <![CDATA[Set the reporter. If the comparison takes a long time the + reporter should be called occasionally to avoid Hadoop timing out + underneath. The default Hadoop timeout is 600 seconds. + @param reporter Progress reporter]]> + </doc> + </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> + <doc> + <![CDATA[An interface for custom order by comparator function.]]> + </doc> + </class> + <!-- end class org.apache.pig.ComparisonFunc --> + <!-- start class org.apache.pig.CounterBasedErrorHandler --> + <class name="CounterBasedErrorHandler" extends="java.lang.Object" + abstract="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="org.apache.pig.ErrorHandler"/> + <constructor name="CounterBasedErrorHandler" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="onSuccess" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="uniqueSignature" type="java.lang.String"/> + </method> + <method name="onError" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="uniqueSignature" type="java.lang.String"/> + <param name="e" type="java.lang.Exception"/> + <param name="inputTuple" type="org.apache.pig.data.Tuple"/> + </method> + <method name="getRecordCount" return="long" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="storeSignature" type="java.lang.String"/> + </method> + <field name="STORER_ERROR_HANDLER_COUNTER_GROUP" type="java.lang.String" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="STORER_ERROR_COUNT" type="java.lang.String" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="STORER_RECORD_COUNT" type="java.lang.String" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + </class> + <!-- end class org.apache.pig.CounterBasedErrorHandler --> + <!-- start interface org.apache.pig.ErrorHandler --> + <interface name="ErrorHandler" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <method name="onSuccess" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="uniqueSignature" type="java.lang.String"/> + <doc> + <![CDATA[Method invoked on success processing of tuple + + @param uniqueSignature + a unique signature to identify the operator]]> + </doc> + </method> + <method name="onError" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="uniqueSignature" type="java.lang.String"/> + <param name="e" type="java.lang.Exception"/> + <param name="inputTuple" type="org.apache.pig.data.Tuple"/> + <doc> + <![CDATA[Method invoked when an error occurs processing of tuple + + @param uniqueSignature + a unique signature to identify the operator + @param e + Exception encountered while processing input + @param inputTuple + the tuple to store.]]> + </doc> + </method> + <doc> + <![CDATA[The interface that handles errors thrown by the + {@link StoreFuncInterface#putNext(Tuple)}]]> + </doc> + </interface> + <!-- end interface org.apache.pig.ErrorHandler --> + <!-- start interface org.apache.pig.ErrorHandling --> + <interface name="ErrorHandling" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <method name="getErrorHandler" return="org.apache.pig.ErrorHandler" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[This method is called to determine the ErrorHandler implementation that + to handle errors in {@code StoreFunc#putNext(Tuple)} + + @return OutputErrorHandler implementation for store func]]> + </doc> + </method> + <doc> + <![CDATA[A {@link StoreFunc} should implement this interface to enable handling errors + during {@code StoreFunc#putNext(Tuple)}]]> + </doc> + </interface> + <!-- end interface org.apache.pig.ErrorHandling --> + <!-- 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"> + <doc> + <![CDATA[Get the Type that this EvalFunc returns. + @return Type]]> + </doc> + </method> + <method name="progress" + abstract="false" native="false" synchronized="false" + static="false" final="true" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Utility method to allow UDF to report progress. If exec will take more than a + a few seconds {@link PigProgressable#progress} should be called + occasionally to avoid timeouts. Default Hadoop timeout is 600 seconds.]]> + </doc> + </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"/> + <doc> + <![CDATA[Issue a warning. Warning messages are aggregated and reported to + the user. + @param msg String message of the warning + @param warningEnum type of warning]]> + </doc> + </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. + Default implementation is a no-op.]]> + </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[Report the schema of the output of this UDF. Pig will make use of + this in error checking, optimization, and planning. The schema + of input data to this UDF is provided. + <p> + The default implementation interprets the {@link OutputSchema} annotation, + if one is present. Otherwise, it returns <code>null</code> (no known output schema). + + @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"/> + <doc> + <![CDATA[Set the reporter. Called by Pig to provide a reference of + the reporter to the UDF. + @param reporter Hadoop reporter]]> + </doc> + </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[Allow a UDF to specify type specific implementations of itself. For example, + an implementation of arithmetic sum might have int and float implementations, + since integer arithmetic performs much better than floating point arithmetic. Pig's + typechecker will call this method and using the returned list plus the schema + of the function's input data, decide which implementation of the UDF to use. + @return A List containing FuncSpec objects representing the EvalFunc class + which can handle the inputs corresponding to the schema in the objects. Each + FuncSpec should be constructed with a schema that describes the input for that + implementation. For example, the sum function above would return two elements in its + list: + <ol> + <li>FuncSpec(this.getClass().getName(), new Schema(new Schema.FieldSchema(null, DataType.DOUBLE))) + <li>FuncSpec(IntSum.getClass().getName(), new Schema(new Schema.FieldSchema(null, DataType.INTEGER))) + </ol> + This would indicate that the main implementation is used for doubles, and the special + implementation IntSum is used for ints.]]> + </doc> + </method> + <method name="getCacheFiles" return="java.util.List" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Allow a UDF to specify a list of hdfs files it would like placed in the distributed + cache. These files will be put in the cache for every job the UDF is used in. + The default implementation returns null. + @return A list of files]]> + </doc> + </method> + <method name="getShipFiles" return="java.util.List" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Allow a UDF to specify a list of local files it would like placed in the distributed + cache. These files will be put in the cache for every job the UDF is used in. Check for + {@link FuncUtils} for utility function to facilitate it + The default implementation returns null. + @return A list of files]]> + </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"/> + <doc> + <![CDATA[Set the PigLogger object. Called by Pig to provide a reference + to the UDF. + @param pigLogger PigLogger object.]]> + </doc> + </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> + <method name="setUDFContextSignature" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="signature" type="java.lang.String"/> + <doc> + <![CDATA[This method will be called by Pig both in the front end and back end to + pass a unique signature to the {@link EvalFunc}. The signature can be used + to store into the {@link UDFContext} any information which the + {@link EvalFunc} needs to store between various method invocations in the + front end and back end. + @param signature a unique signature to identify this EvalFunc]]> + </doc> + </method> + <method name="setInputSchema" + 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[This method is for internal use. It is called by Pig core in both front-end + and back-end to setup the right input schema for EvalFunc]]> + </doc> + </method> + <method name="getInputSchema" 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[This method is intended to be called by the user in {@link EvalFunc} to get the input + schema of the EvalFunc]]> + </doc> + </method> + <method name="getSchemaType" return="org.apache.pig.EvalFunc.SchemaType" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Returns the {@link SchemaType} of the EvalFunc. User defined functions can override + this method to return {@link SchemaType#VARARG}. In this case the last FieldSchema + added to the Schema in {@link #getArgToFuncMapping()} will be considered as a vararg field. + + @return the schema type of the UDF]]> + </doc> + </method> + <method name="allowCompileTimeCalculation" return="boolean" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Whether the UDF should be evaluated at compile time if all inputs are constant. + This is applicable for most UDF, however, if a UDF will access hdfs file which + is not available at compile time, it has to be false + @return Whether or not compile time calculation is allowed, default to false + to ensure legacy UDF will get the right behavior]]> + </doc> + </method> + <method name="needEndOfAllInputProcessing" return="boolean" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="setEndOfAllInput" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="endOfAllInput" type="boolean"/> + </method> + <method name="getLoadCaster" return="org.apache.pig.LoadCaster" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <exception name="IOException" type="java.io.IOException"/> + <doc> + <![CDATA[This will be called on both the front end and the back + end during execution. + @return the {@link LoadCaster} associated with this eval. Returning null + indicates that casts from bytearray will pick the one associated with the + parameters when they all come from the same loadcaster type. + @throws IOException if there is an exception during LoadCaster]]> + </doc> + </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"> + <doc> + <![CDATA[Reporter to send heartbeats to Hadoop. If exec will take more than a + a few seconds {@link PigProgressable#progress} should be called + occasionally to avoid timeouts. Default Hadoop timeout is 600 seconds.]]> + </doc> + </field> + <field name="log" type="org.apache.commons.logging.Log" + transient="false" volatile="false" + static="false" final="false" visibility="protected" + deprecated="not deprecated"> + <doc> + <![CDATA[Logging object. Log calls made on the front end will be sent to + pig's log on the client. Log calls made on the backend will be + sent to stdout and can be seen in the Hadoop logs.]]> + </doc> + </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"> + <doc> + <![CDATA[Logger for aggregating warnings. Any warnings to be sent to the user + should be logged to this via {@link PigLogger#warn}.]]> + </doc> + </field> + <field name="returnType" type="java.lang.reflect.Type" + transient="false" volatile="false" + static="false" final="false" visibility="protected" + deprecated="not deprecated"> + <doc> + <![CDATA[Return type of this instance of EvalFunc.]]> + </doc> + </field> + <doc> + <![CDATA[The class is used to implement functions to be applied to + fields in 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 exec() 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.EvalFunc.SchemaType --> + <class name="EvalFunc.SchemaType" extends="java.lang.Enum" + abstract="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + <method name="values" return="org.apache.pig.EvalFunc.SchemaType[]" + abstract="false" native="false" synchronized="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="valueOf" return="org.apache.pig.EvalFunc.SchemaType" + 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="NORMAL" type="org.apache.pig.EvalFunc.SchemaType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="VARARG" type="org.apache.pig.EvalFunc.SchemaType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <doc> + <![CDATA[EvalFunc's schema type. + @see {@link EvalFunc#getSchemaType()}]]> + </doc> + </class> + <!-- end class org.apache.pig.EvalFunc.SchemaType --> + <!-- start interface org.apache.pig.ExceptionalFunction --> + <interface name="ExceptionalFunction" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <method name="apply" return="java.lang.Object" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="item" type="java.lang.Object"/> + <exception name="Exception" type="java.lang.Exception"/> + <doc> + <![CDATA[Performs a unit of work on item, possibly throwing {@code E} in the process. + + @param item The item to perform work against. + @return The result of the computation. + @throws E if there was a problem performing the work.]]> + </doc> + </method> + <doc> + <![CDATA[An interface that captures a unit of work against an item where an exception might be thrown. + + @param <S> The argument type for the function. + @param <T> The return type for the function. + @param <E> The exception type that the function throws.]]> + </doc> + </interface> + <!-- end interface org.apache.pig.ExceptionalFunction --> + <!-- start interface org.apache.pig.ExecType --> + <interface name="ExecType" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="java.io.Serializable"/> + <method name="accepts" return="boolean" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="properties" type="java.util.Properties"/> + <doc> + <![CDATA[An ExecType is selected based off the Properties for the given script. + There may be multiple settings that trigger the selection of a given + ExecType. For example, distributed MR mode is currently triggered if the + user specifies "mapred" or "mapreduce". It is desirable to override the + toString method of the given ExecType to uniquely identify the ExecType. + + The initialize method should return true if it accepts the properties or + false if it does not. The Java ServiceLoader framework will be used to + iterate through and select the correct ExecType.]]> + </doc> + </method> + <method name="getExecutionEngine" return="org.apache.pig.backend.executionengine.ExecutionEngine" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="pigContext" type="org.apache.pig.impl.PigContext"/> + <doc> + <![CDATA[Returns the Execution Engine that this ExecType is associated with. Once + the ExecType the script is running in is determined by the PigServer, it + will then call this method to get an instance of the ExecutionEngine + associated with this ExecType to delegate all further execution to on the + backend.]]> + </doc> + </method> + <method name="getExecutionEngineClass" return="java.lang.Class" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Returns the Execution Engine class that this ExecType is associated with. + This method simply returns the class of the ExecutionEngine associated + with this ExecType, and not an instance of it.]]> + </doc> + </method> + <method name="isLocal" return="boolean" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[An ExecType is classified as local if it runs in-process and through the + local filesystem. While an ExecutionEngine may have a more nuanced notion + of local mode, these are the qualifications Pig requires. + ExecutionEngines can extend the ExecType interface to additionally + differentiate between ExecTypes as necessary.]]> + </doc> + </method> + <method name="name" return="java.lang.String" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[Returns the canonical name for this ExecType. + @return]]> + </doc> + </method> + <field name="LOCAL" type="org.apache.pig.ExecType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="MAPREDUCE" type="org.apache.pig.ExecType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <doc> + <![CDATA[The type of query execution. Pig will cycle through all implementations + of ExecType and choose the first one that matches the Properties passed in. + This ExecType then dictates the ExecutionEngine used for processing and + other behaviour throughout Pig. Any implementing classes should be noted in + the META-INF/services folder titled org.apache.pig.ExecType as per the + Java ServiceLoader specification.]]> + </doc> + </interface> + <!-- end interface org.apache.pig.ExecType --> + <!-- start class org.apache.pig.ExecTypeProvider --> + <class name="ExecTypeProvider" extends="java.lang.Object" + abstract="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <constructor name="ExecTypeProvider" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="selectExecType" return="org.apache.pig.ExecType" + abstract="false" native="false" synchronized="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <param name="properties" type="java.util.Properties"/> + <exception name="PigException" type="org.apache.pig.PigException"/> + </method> + <method name="fromString" return="org.apache.pig.ExecType" + abstract="false" native="false" synchronized="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <param name="execType" type="java.lang.String"/> + <exception name="PigException" type="org.apache.pig.PigException"/> + </method> + </class> + <!-- end class org.apache.pig.ExecTypeProvider --> + <!-- start class org.apache.pig.Expression --> + <class name="Expression" extends="java.lang.Object" + abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <constructor name="Expression" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="getOpType" return="org.apache.pig.Expression.OpType" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[@return the opType]]> + </doc> + </method> + <field name="opType" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="false" final="false" visibility="protected" + deprecated="not deprecated"> + </field> + <doc> + <![CDATA[A class to communicate Filter expressions to LoadFuncs. + @since Pig 0.7]]> + </doc> + </class> + <!-- end class org.apache.pig.Expression --> + <!-- start class org.apache.pig.Expression.BetweenExpression --> + <class name="Expression.BetweenExpression" extends="org.apache.pig.Expression" + abstract="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <constructor name="BetweenExpression" type="java.lang.Object, java.lang.Object" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="getLower" return="java.lang.Object" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="getUpper" return="java.lang.Object" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="toString" return="java.lang.String" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + </class> + <!-- end class org.apache.pig.Expression.BetweenExpression --> + <!-- start class org.apache.pig.Expression.BinaryExpression --> + <class name="Expression.BinaryExpression" extends="org.apache.pig.Expression" + abstract="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <constructor name="BinaryExpression" type="org.apache.pig.Expression, org.apache.pig.Expression, org.apache.pig.Expression.OpType" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[@param lhs + @param rhs]]> + </doc> + </constructor> + <method name="getLhs" return="org.apache.pig.Expression" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[@return the left hand operand]]> + </doc> + </method> + <method name="getRhs" return="org.apache.pig.Expression" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[@return the right hand operand]]> + </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> + </class> + <!-- end class org.apache.pig.Expression.BinaryExpression --> + <!-- start class org.apache.pig.Expression.Column --> + <class name="Expression.Column" extends="org.apache.pig.Expression" + abstract="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <constructor name="Column" type="java.lang.String" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[@param name]]> + </doc> + </constructor> + <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="getName" return="java.lang.String" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[@return the name]]> + </doc> + </method> + <method name="setName" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="name" type="java.lang.String"/> + <doc> + <![CDATA[@param name the name to set]]> + </doc> + </method> + </class> + <!-- end class org.apache.pig.Expression.Column --> + <!-- start class org.apache.pig.Expression.Const --> + <class name="Expression.Const" extends="org.apache.pig.Expression" + abstract="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <constructor name="Const" type="java.lang.Object" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[@param value]]> + </doc> + </constructor> + <method name="getValue" return="java.lang.Object" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <doc> + <![CDATA[@return the value]]> + </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> + </class> + <!-- end class org.apache.pig.Expression.Const --> + <!-- start class org.apache.pig.Expression.InExpression --> + <class name="Expression.InExpression" extends="org.apache.pig.Expression" + abstract="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <constructor name="InExpression" type="java.util.List" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="getValues" return="java.util.List" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="toString" return="java.lang.String" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + </class> + <!-- end class org.apache.pig.Expression.InExpression --> + <!-- start class org.apache.pig.Expression.OpType --> + <class name="Expression.OpType" extends="java.lang.Enum" + abstract="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + <method name="values" return="org.apache.pig.Expression.OpType[]" + abstract="false" native="false" synchronized="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="valueOf" return="org.apache.pig.Expression.OpType" + abstract="false" native="false" synchronized="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <param name="name" type="java.lang.String"/> + </method> + <method name="toString" return="java.lang.String" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <field name="OP_PLUS" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_MINUS" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_TIMES" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_DIV" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_MOD" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_EQ" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_NE" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_GT" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_GE" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_LT" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_LE" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_MATCH" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_IN" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_BETWEEN" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_NULL" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_NOT" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_AND" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="OP_OR" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="TERM_COL" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + <field name="TERM_CONST" type="org.apache.pig.Expression.OpType" + transient="false" volatile="false" + static="true" final="true" visibility="public" + deprecated="not deprecated"> + </field> + </class> + <!-- end class org.apache.pig.Expression.OpType --> + <!-- start class org.apache.pig.Expression.UnaryExpression --> + <class name="Expression.UnaryExpression" extends="org.apache.pig.Expression" + abstract="false" + static="true" final="false" visibility="public" + deprecated="not deprecated"> + <constructor name="UnaryExpression" type="org.apache.pig.Expression, org.apache.pig.Expression.OpType" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="getExpression" return="org.apache.pig.Expression" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="toString" return="java.lang.String" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + </class> + <!-- end class org.apache.pig.Expression.UnaryExpression --> + <!-- start class org.apache.pig.FileInputLoadFunc --> + <class name="FileInputLoadFunc" extends="org.apache.pig.LoadFunc" + abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="org.apache.pig.OrderedLoadFunc"/> + <constructor name="FileInputLoadFunc" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="getSplitComparable" return="org.apache.hadoop.io.WritableComparable" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="split" type="org.apache.hadoop.mapreduce.InputSplit"/> + <exception name="IOException" type="java.io.IOException"/> + </method> + <doc> + <![CDATA[This class provides an implementation of OrderedLoadFunc interface + which can be optionally re-used by LoadFuncs that use FileInputFormat, by + having this as a super class + @since Pig 0.7]]> + </doc> + </class> + <!-- end class org.apache.pig.FileInputLoadFunc --> + <!-- start class org.apache.pig.FileSplitComparable --> + <class name="FileSplitComparable" extends="java.lang.Object" + abstract="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="org.apache.hadoop.io.WritableComparable"/> + <implements name="java.io.Serializable"/> + <constructor name="FileSplitComparable" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <constructor name="FileSplitComparable" type="java.lang.String, long" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="compareTo" return="int" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="other" type="org.apache.pig.FileSplitComparable"/> + </method> + <method name="readFields" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="in" type="java.io.DataInput"/> + <exception name="IOException" type="java.io.IOException"/> + </method> + <method name="write" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="out" type="java.io.DataOutput"/> + <exception name="IOException" type="java.io.IOException"/> + </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="hashCode" return="int" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="equals" return="boolean" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="obj" type="java.lang.Object"/> + </method> + <field name="filename" type="java.lang.String" + transient="false" volatile="false" + static="false" final="false" visibility="protected" + deprecated="not deprecated"> + </field> + <field name="offset" type="java.lang.Long" + transient="false" volatile="false" + static="false" final="false" visibility="protected" + deprecated="not deprecated"> + </field> + <doc> + <![CDATA[This class represents a relative position in a file. It records a filename + and an offset. This allows Pig to order FileSplits. + @since Pig 0.7]]> + </doc> + </class> + <!-- end class org.apache.pig.FileSplitComparable --> + <!-- 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. + Default implementation is a no-op.]]> + </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 to pass the constructor for the above class. + Constructors can only take strings.]]> + </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 to pass to the constructor for the above class. + Constructors can only take strings.]]> + </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 to pass to the constructor for the above class. + Constructors can only take strings. + @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"/> + <doc> + <![CDATA[Parse the class name out of a function specification string. + @return name of the class.]]> + </doc> + </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"/> + <doc> + <![CDATA[Get the argument values passed to the func spec. + @return argument values. Format will be arg1, arg2, ... )]]> + </doc> + </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[Parse the argument values out of a function specification string. + @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="equals" return="boolean" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="other" type="java.lang.Object"/> + </method> + <method name="hashCode" return="int" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </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. + Encapsulates the class name and the arguments to the constructor.]]> + </doc> + </class> + <!-- end class org.apache.pig.FuncSpec --> + <!-- start interface org.apache.pig.Function --> + <interface name="Function" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="org.apache.pig.ExceptionalFunction"/> + <implements name="com.google.common.base.Function"/> + <method name="apply" return="java.lang.Object" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="item" type="java.lang.Object"/> + </method> + <doc> + <![CDATA[A convenience typedef that ties into both google's {@code Function} and + {@code ExceptionalFunction}. + + @param <S> The argument type for the function. + @param <T> The return type for the function.]]> + </doc> + </interface> + <!-- end interface org.apache.pig.Function --> + <!-- start interface org.apache.pig.IndexableLoadFunc --> + <interface name="IndexableLoadFunc" abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <method name="initialize" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="conf" type="org.apache.hadoop.conf.Configuration"/> + <exception name="IOException" type="java.io.IOException"/> + <doc> + <![CDATA[This method is called by Pig run time to allow the + IndexableLoadFunc to perform any initialization actions + @param conf The job configuration object + @throws IOException]]> + </doc> + </method> + <method name="seekNear" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <param name="keys" type="org.apache.pig.data.Tuple"/> + <exception name="IOException" type="java.io.IOException"/> + <doc> + <![CDATA[This method is called by the Pig runtime to indicate + to the LoadFunc to position its underlying input stream + near the keys supplied as the argument. Specifically: + 1) if the keys are present in the input stream, the loadfunc + implementation should position its read position to + a record where the key(s) is/are the biggest key(s) less than + the key(s) supplied in the argument OR to the record with the + first occurrence of the keys(s) supplied. + 2) if the key(s) are absent in the input stream, the implementation + should position its read position to a record where the key(s) + is/are the biggest key(s) less than the key(s) supplied OR to the + first record where the key(s) is/are the smallest key(s) greater + than the keys(s) supplied. + The description above holds for descending order data in + a similar manner with "biggest" and "less than" replaced with + "smallest" and "greater than" and vice versa. + + @param keys Tuple with join keys (which are a prefix of the sort + keys of the input data). For example if the data is sorted on + columns in position 2,4,5 any of the following Tuples are + valid as an argument value: + (fieldAt(2)) + (fieldAt(2), fieldAt(4)) + (fieldAt(2), fieldAt(4), fieldAt(5)) + + The following are some invalid cases: + (fieldAt(4)) + (fieldAt(2), fieldAt(5)) + (fieldAt(4), fieldAt(5)) + + @throws IOException When the loadFunc is unable to position + to the required point in its input stream]]> + </doc> + </method> + <method name="close" + abstract="true" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <exception name="IOException" type="java.io.IOException"/> + <doc> + <![CDATA[A method called by the Pig runtime to give an opportunity + for implementations to perform cleanup actions like closing + the underlying input stream. This is necessary since while + performing a join the Pig run time may determine than no further + join is possible with remaining records and may indicate to the + IndexableLoader to cleanup by calling this method. + + @throws IOException if the loadfunc is unable to perform + its close actions.]]> + </doc> + </method> + <doc> + <![CDATA[This class is intended for use by LoadFunc implementations + which have an internal index for sorted data and can use the index + to support merge join in Pig. Interaction with the index + is abstracted away by the methods in this interface which the Pig + runtime will call in a particular sequence to get the records it + needs to perform the merge based join. + + The sequence of calls made from the Pig runtime are: + <ol> + <li>{@link LoadFunc#setUDFContextSignature(String)} + <li>{@link IndexableLoadFunc#initialize(Configuration)} + <li>{@link LoadFunc#setLocation(String, org.apache.hadoop.mapreduce.Job)} + <li>{@link IndexableLoadFunc#seekNear(Tuple)} + <li>{@link LoadFunc#getNext} called multiple times to retrieve data and perform the join + <li>{@link IndexableLoadFunc#close} + </ol> + @since Pig 0.6]]> + </doc> + </interface> + <!-- end interface org.apache.pig.IndexableLoadFunc --> + <!-- start class org.apache.pig.IteratingAccumulatorEvalFunc --> + <class name="IteratingAccumulatorEvalFunc" extends="org.apache.pig.AccumulatorEvalFunc" + abstract="true" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + <implements name="org.apache.pig.TerminatingAccumulator"/> + <constructor name="IteratingAccumulatorEvalFunc" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </constructor> + <method name="isFinished" return="boolean" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="accumulate" + abstract="false" 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"/> + </method> + <method name="getValue" return="java.lang.Object" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method> + <method name="cleanup" + abstract="false" native="false" synchronized="false" + static="false" final="false" visibility="public" + deprecated="not deprecated"> + </method>
[... 91510 lines stripped ...]