Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 677BE200B50 for ; Fri, 29 Jul 2016 21:43:17 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 6638D160AA7; Fri, 29 Jul 2016 19:43:17 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 149E7160AA6 for ; Fri, 29 Jul 2016 21:43:14 +0200 (CEST) Received: (qmail 44959 invoked by uid 500); 29 Jul 2016 19:43:14 -0000 Mailing-List: contact commits-help@pirk.incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@pirk.incubator.apache.org Delivered-To: mailing list commits@pirk.incubator.apache.org Received: (qmail 44944 invoked by uid 99); 29 Jul 2016 19:43:14 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd2-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 29 Jul 2016 19:43:14 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd2-us-west.apache.org (ASF Mail Server at spamd2-us-west.apache.org) with ESMTP id A7E001A5D17 for ; Fri, 29 Jul 2016 19:43:13 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd2-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.446 X-Spam-Level: X-Spam-Status: No, score=-3.446 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, KAM_MANYCOMMENTS=1.2, RCVD_IN_DNSWL_HI=-5, RCVD_IN_MSPIKE_H3=-0.01, RCVD_IN_MSPIKE_WL=-0.01, RP_MATCHES_RCVD=-1.426] autolearn=disabled Received: from mx2-lw-us.apache.org ([10.40.0.8]) by localhost (spamd2-us-west.apache.org [10.40.0.9]) (amavisd-new, port 10024) with ESMTP id yD6diJMz-LbT for ; Fri, 29 Jul 2016 19:42:49 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx2-lw-us.apache.org (ASF Mail Server at mx2-lw-us.apache.org) with SMTP id DAA7760E25 for ; Fri, 29 Jul 2016 19:42:47 +0000 (UTC) Received: (qmail 43952 invoked by uid 99); 29 Jul 2016 19:42:47 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 29 Jul 2016 19:42:47 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id F320DEE694; Fri, 29 Jul 2016 19:42:46 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: eawilliams@apache.org To: commits@pirk.incubator.apache.org Date: Fri, 29 Jul 2016 19:43:01 -0000 Message-Id: <037cfc4fb92842949cba37e92e6543fa@git.apache.org> In-Reply-To: <658b3cdafaa441319446e1b63269f49d@git.apache.org> References: <658b3cdafaa441319446e1b63269f49d@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [16/47] incubator-pirk git commit: updating website javadocs archived-at: Fri, 29 Jul 2016 19:43:17 -0000 http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cb436a97/javadocs/test/org/apache/pirk/schema/data/DataSchema.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/DataSchema.html b/javadocs/test/org/apache/pirk/schema/data/DataSchema.html deleted file mode 100644 index 3ea81de..0000000 --- a/javadocs/test/org/apache/pirk/schema/data/DataSchema.html +++ /dev/null @@ -1,433 +0,0 @@ - - - - - -DataSchema - - - - - - - - - - - -
-
org.apache.pirk.schema.data
-

Class DataSchema

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • org.apache.pirk.schema.data.DataSchema
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    -
    public class DataSchema
    -extends java.lang.Object
    -implements java.io.Serializable
    -
    A data schema describes the target data being referenced by a Querier and a Responder. -

    - The schema comprises a number of elements, each of which has a name, type, and a partitioner. Elements may be declared as arrays of types. -

    - Schemas are typically loaded from XML descriptors.

    -
    See Also:
    DataSchemaLoader, -Serialized Form
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      booleancontainsElement(java.lang.String elementName) -
      Returns true if the data schema contains an element with the given name.
      -
      java.util.Set<java.lang.String>getArrayElements() -
      Returns the element names that are declared as arrays.
      -
      java.util.Set<java.lang.String>getElementNames() -
      Returns the set of element names defined by this schema.
      -
      java.lang.StringgetElementType(java.lang.String elementName) -
      Returns the name of the Java type associated with the given element name.
      -
      java.util.Set<java.lang.String>getNonArrayElements() -
      Returns the element names that are declared to not be arrays.
      -
      DataPartitionergetPartitionerForElement(java.lang.String elementName) -
      Returns the partitioner instance for the given element name.
      -
      DataPartitionergetPartitionerInstance(java.lang.String partitionerTypeName) -
      Returns the partitioner corresponding to the given partitioner class name.
      -
      java.lang.StringgetPartitionerTypeName(java.lang.String elementName) -
      Returns the partitioner type name for a given element name.
      -
      java.lang.StringgetSchemaName() -
      Returns the name of this schema.
      -
      org.apache.hadoop.io.TextgetTextName(java.lang.String elementName) -
      Returns the Hadoop text representation of a given element name.
      -
      booleanisArrayElement(java.lang.String element) -
      Returns true if the given element name is an array type.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        containsElement

        -
        public boolean containsElement(java.lang.String elementName)
        -
        Returns true if the data schema contains an element with the given name.
        -
        Parameters:
        elementName - The element name to check.
        -
        Returns:
        true if the schema does define an element with that name, of false otherwise.
        -
      • -
      - - - -
        -
      • -

        getElementNames

        -
        public java.util.Set<java.lang.String> getElementNames()
        -
        Returns the set of element names defined by this schema.
        -
        Returns:
        The possibly empty set of element names.
        -
      • -
      - - - -
        -
      • -

        getElementType

        -
        public java.lang.String getElementType(java.lang.String elementName)
        -
        Returns the name of the Java type associated with the given element name. -

        - The Java type is either a primitive type name, as defined in the PrimitiveTypePartitioner, or a full canonical class name representing the element - type.

        -
        Parameters:
        elementName - The element name whose type is requested.
        -
        Returns:
        The type of the element, or null if the schema does not define the given element name.
        See Also:
        PrimitiveTypePartitioner
        -
      • -
      - - - -
        -
      • -

        getArrayElements

        -
        public java.util.Set<java.lang.String> getArrayElements()
        -
        Returns the element names that are declared as arrays.
        -
        Returns:
        The set of names that are arrays, or an empty set if none.
        -
      • -
      - - - -
        -
      • -

        getNonArrayElements

        -
        public java.util.Set<java.lang.String> getNonArrayElements()
        -
        Returns the element names that are declared to not be arrays.
        -
        Returns:
        The set of names that are not arrays, or an empty set if none.
        -
      • -
      - - - -
        -
      • -

        getPartitionerForElement

        -
        public DataPartitioner getPartitionerForElement(java.lang.String elementName)
        -                                         throws PIRException
        -
        Returns the partitioner instance for the given element name. -

        - A partitioner for the named type is created on first request, and the same partitioner is returned on subsequent calls.

        -
        Parameters:
        elementName - the name of the element whose partitioner is required.
        -
        Returns:
        the data partitioner, or null if the element does not exist.
        -
        Throws:
        -
        PIRExcpetion - if the partitioner cannot be instantiated.
        -
        PIRException
        See Also:
        getPartitionerInstance(String)
        -
      • -
      - - - -
        -
      • -

        getPartitionerInstance

        -
        public DataPartitioner getPartitionerInstance(java.lang.String partitionerTypeName)
        -                                       throws PIRException
        -
        Returns the partitioner corresponding to the given partitioner class name. -

        - A partitioner for the named type is created on first request, and the same partitioner is returned on subsequent calls to this method.

        -
        Parameters:
        partitionerTypeName - The class name for a partitioner type.
        -
        Returns:
        The partitioner instance of the requested type.
        -
        Throws:
        -
        PIRException - If a problem occurs instantiating a new partitioner of the requested type.
        -
      • -
      - - - -
        -
      • -

        getPartitionerTypeName

        -
        public java.lang.String getPartitionerTypeName(java.lang.String elementName)
        -
        Returns the partitioner type name for a given element name. -

        - The partitioner type name is either that of the primitive partitioner, where the element name is a primitive type. For non-primitives it is the fully - qualified name of a Java class that implements the DataPartitioner interface.

        -
        Parameters:
        elementName - The element name whose partitioner type is requested.
        -
        Returns:
        The type name of the element's partitioner, or null if there is no element of that name.
        -
      • -
      - - - -
        -
      • -

        getSchemaName

        -
        public java.lang.String getSchemaName()
        -
        Returns the name of this schema.
        -
        Returns:
        The schema name.
        -
      • -
      - - - -
        -
      • -

        getTextName

        -
        public org.apache.hadoop.io.Text getTextName(java.lang.String elementName)
        -
        Returns the Hadoop text representation of a given element name.
        -
        Parameters:
        elementName - The name of the element whose text representation is requested.
        -
      • -
      - - - -
        -
      • -

        isArrayElement

        -
        public boolean isArrayElement(java.lang.String element)
        -
        Returns true if the given element name is an array type. -

        - The method returns false if the element is not an array type or the schema does not define an element of this type.

        -
        Parameters:
        element - The name of the element to test.
        -
        Returns:
        true if the element is an array type, and false otherwise.
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cb436a97/javadocs/test/org/apache/pirk/schema/data/DataSchemaLoader.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/DataSchemaLoader.html b/javadocs/test/org/apache/pirk/schema/data/DataSchemaLoader.html deleted file mode 100644 index fa539d3..0000000 --- a/javadocs/test/org/apache/pirk/schema/data/DataSchemaLoader.html +++ /dev/null @@ -1,325 +0,0 @@ - - - - - -DataSchemaLoader - - - - - - - - - - - -
-
org.apache.pirk.schema.data
-

Class DataSchemaLoader

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • org.apache.pirk.schema.data.DataSchemaLoader
    • -
    -
  • -
-
-
    -
  • -
    -
    -
    public class DataSchemaLoader
    -extends java.lang.Object
    -
    Class to load any data schemas specified in the properties file, 'data.schemas' -

    - Schemas should be specified as follows; all items are treated in a case insensitive manner: - -

    - <schema>
    -  <schemaName> name of the schema </schemaName>
    -  <element>
    -      <name> element name /name>
    -      <type> class name or type name (if Java primitive type) of the element </type>
    -      <isArray> true or false -- whether or not the schema element is an array within the data </isArray>
    -      <partitioner> optional - Partitioner class for the element; defaults to primitive java type partitioner </partitioner> 
    -  </element>
    - </schema>
    - 
    - 
    - - Primitive types must be one of the following: "byte", "short", "int", "long", "float", "double", "char", "string" -

    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      DataSchemaLoader() 
      -
    • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static voidinitialize() -
      Kept for compatibility
      -
      static voidinitialize(boolean hdfs, - org.apache.hadoop.fs.FileSystem fs) -
      Kept for compatibility
      -
      DataSchemaloadSchema(java.io.InputStream stream) -
      Returns the data schema as defined in XML format on the given stream.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        DataSchemaLoader

        -
        public DataSchemaLoader()
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        initialize

        -
        public static void initialize()
        -                       throws java.lang.Exception
        -
        Kept for compatibility
        -
        Throws:
        -
        java.lang.Exception
        -
      • -
      - - - -
        -
      • -

        initialize

        -
        public static void initialize(boolean hdfs,
        -              org.apache.hadoop.fs.FileSystem fs)
        -                       throws java.lang.Exception
        -
        Kept for compatibility
        -
        Throws:
        -
        java.lang.Exception
        -
      • -
      - - - -
        -
      • -

        loadSchema

        -
        public DataSchema loadSchema(java.io.InputStream stream)
        -                      throws java.io.IOException,
        -                             PIRException
        -
        Returns the data schema as defined in XML format on the given stream.
        -
        Parameters:
        stream - The source of the XML data schema description.
        -
        Returns:
        The data schema.
        -
        Throws:
        -
        java.io.IOException - A problem occurred reading from the given stream.
        -
        PIRException - The schema description is invalid.
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cb436a97/javadocs/test/org/apache/pirk/schema/data/DataSchemaRegistry.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/DataSchemaRegistry.html b/javadocs/test/org/apache/pirk/schema/data/DataSchemaRegistry.html deleted file mode 100644 index 403b2b6..0000000 --- a/javadocs/test/org/apache/pirk/schema/data/DataSchemaRegistry.html +++ /dev/null @@ -1,267 +0,0 @@ - - - - - -DataSchemaRegistry - - - - - - - - - - - -
-
org.apache.pirk.schema.data
-

Class DataSchemaRegistry

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • org.apache.pirk.schema.data.DataSchemaRegistry
    • -
    -
  • -
-
-
    -
  • -
    -
    -
    public class DataSchemaRegistry
    -extends java.lang.Object
    -
    The data schema registry is a global location for data schema descriptors.
    -
    See Also:
    DataSchema, -DataSchemaLoader
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static DataSchemaget(java.lang.String schemaName) -
      Returns the data schema with the given name.
      -
      static java.util.Set<java.lang.String>getNames() -
      Returns the set of data schema names held in the registry.
      -
      static DataSchemaput(DataSchema schema) -
      Adds the given data schema to the registry.
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        put

        -
        public static DataSchema put(DataSchema schema)
        -
        Adds the given data schema to the registry. - - If there was an existing schema with the same name, it is replaced.
        -
        Parameters:
        schema - The data schema to add.
        -
        Returns:
        the previous schema registered at the same name, or null if there were none.
        -
      • -
      - - - -
        -
      • -

        get

        -
        public static DataSchema get(java.lang.String schemaName)
        -
        Returns the data schema with the given name.
        -
        Parameters:
        schemaName - The data schema name to be returned.
        -
        Returns:
        The data schema, or null if no such schema.
        -
      • -
      - - - -
        -
      • -

        getNames

        -
        public static java.util.Set<java.lang.String> getNames()
        -
        Returns the set of data schema names held in the registry.
        -
        Returns:
        The possibly empty set of data schema names.
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cb436a97/javadocs/test/org/apache/pirk/schema/data/LoadDataSchemas.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/LoadDataSchemas.html b/javadocs/test/org/apache/pirk/schema/data/LoadDataSchemas.html deleted file mode 100644 index 99649fe..0000000 --- a/javadocs/test/org/apache/pirk/schema/data/LoadDataSchemas.html +++ /dev/null @@ -1,335 +0,0 @@ - - - - - -LoadDataSchemas - - - - - - - - - - - -
-
org.apache.pirk.schema.data
-

Class LoadDataSchemas

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • org.apache.pirk.schema.data.LoadDataSchemas
    • -
    -
  • -
-
-
    -
  • -
    -
    -
    public class LoadDataSchemas
    -extends java.lang.Object
    -
    Class to load any data schemas specified in the properties file, 'data.schemas' -

    - Schemas should be specified as follows; all items are treated in a case insensitive manner: - -

    - <schema>
    -  <schemaName> name of the schema </schemaName>
    -  <element>
    -      <name> element name /name>
    -      <type> class name or type name (if Java primitive type) of the element </type>
    -      <isArray> true or false -- whether or not the schema element is an array within the data </isArray>
    -      <partitioner> optional - Partitioner class for the element; defaults to primitive java type partitioner </partitioner> 
    -  </element>
    - </schema>
    - 
    - 
    - - Primitive types must be one of the following: "byte", "short", "int", "long", "float", "double", "char", "string" -

    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      LoadDataSchemas() 
      -
    • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static DataSchemagetSchema(java.lang.String schemaName) 
      static java.util.HashMap<java.lang.String,DataSchema>getSchemaMap() 
      static java.util.Set<java.lang.String>getSchemaNames() 
      static voidinitialize() 
      static voidinitialize(boolean hdfs, - org.apache.hadoop.fs.FileSystem fs) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

        -equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LoadDataSchemas

        -
        public LoadDataSchemas()
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        initialize

        -
        public static void initialize()
        -                       throws java.lang.Exception
        -
        Throws:
        -
        java.lang.Exception
        -
      • -
      - - - -
        -
      • -

        initialize

        -
        public static void initialize(boolean hdfs,
        -              org.apache.hadoop.fs.FileSystem fs)
        -                       throws java.lang.Exception
        -
        Throws:
        -
        java.lang.Exception
        -
      • -
      - - - -
        -
      • -

        getSchemaMap

        -
        public static java.util.HashMap<java.lang.String,DataSchema> getSchemaMap()
        -
      • -
      - - - -
        -
      • -

        getSchemaNames

        -
        public static java.util.Set<java.lang.String> getSchemaNames()
        -
      • -
      - - - -
        -
      • -

        getSchema

        -
        public static DataSchema getSchema(java.lang.String schemaName)
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/cb436a97/javadocs/test/org/apache/pirk/schema/data/class-use/DataSchema.html ---------------------------------------------------------------------- diff --git a/javadocs/test/org/apache/pirk/schema/data/class-use/DataSchema.html b/javadocs/test/org/apache/pirk/schema/data/class-use/DataSchema.html deleted file mode 100644 index e5dd575..0000000 --- a/javadocs/test/org/apache/pirk/schema/data/class-use/DataSchema.html +++ /dev/null @@ -1,385 +0,0 @@ - - - - - -Uses of Class org.apache.pirk.schema.data.DataSchema - - - - - - - - - - -
-

Uses of Class
org.apache.pirk.schema.data.DataSchema

-
-
- -
- - - - - -