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 1893C200B53 for ; Tue, 12 Jul 2016 19:08:23 +0200 (CEST) Received: by cust-asf.ponee.io (Postfix) id 171CA160A53; Tue, 12 Jul 2016 17:08:23 +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 C81A9160A56 for ; Tue, 12 Jul 2016 19:08:20 +0200 (CEST) Received: (qmail 22709 invoked by uid 500); 12 Jul 2016 17:08:20 -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 22699 invoked by uid 99); 12 Jul 2016 17:08:20 -0000 Received: from pnap-us-west-generic-nat.apache.org (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 12 Jul 2016 17:08:20 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 697AEC7FD1 for ; Tue, 12 Jul 2016 17:08:19 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: -3.307 X-Spam-Level: X-Spam-Status: No, score=-3.307 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.287] autolearn=disabled Received: from mx2-lw-eu.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id ZD2w7lhBo3Eh for ; Tue, 12 Jul 2016 17:08:15 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx2-lw-eu.apache.org (ASF Mail Server at mx2-lw-eu.apache.org) with SMTP id 836C160CEF for ; Tue, 12 Jul 2016 17:08:12 +0000 (UTC) Received: (qmail 22468 invoked by uid 99); 12 Jul 2016 17:08:11 -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; Tue, 12 Jul 2016 17:08:11 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 73A19E1021; Tue, 12 Jul 2016 17:08:11 +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: Tue, 12 Jul 2016 17:08:25 -0000 Message-Id: <5d2bd763da1a4f609cdd048536207776@git.apache.org> In-Reply-To: <2b9a7a8e44c74cefa725b505906ee840@git.apache.org> References: <2b9a7a8e44c74cefa725b505906ee840@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [15/48] incubator-pirk git commit: removing the pirk-site directory from master; it has moved into the gh-pages branch archived-at: Tue, 12 Jul 2016 17:08:23 -0000 http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/3cf5ed7e/pirk-site/javadocs/org/apache/pirk/schema/query/LoadQuerySchemas.html ---------------------------------------------------------------------- diff --git a/pirk-site/javadocs/org/apache/pirk/schema/query/LoadQuerySchemas.html b/pirk-site/javadocs/org/apache/pirk/schema/query/LoadQuerySchemas.html deleted file mode 100644 index af352c7..0000000 --- a/pirk-site/javadocs/org/apache/pirk/schema/query/LoadQuerySchemas.html +++ /dev/null @@ -1,415 +0,0 @@ - - - - - -LoadQuerySchemas - - - - - - - - - - - -
-
org.apache.pirk.schema.query
-

Class LoadQuerySchemas

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

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

    - <schema>
    -    <schemaName> name of the schema </schemaName>
    -    <dataSchemaName> name of the data schema over which this query is run </dataSchemaName>
    -    <selectorName> name of the element in the data schema that will be the selector </selectorName>
    -    <elements>
    -       <name> element name of element in the data schema to include in the query response </name>
    -    </elements>
    -    <filter> (optional) name of the filter class to use to filter the data </filter>
    -    <filterNames> (optional)
    -       <name> element name of element in the data schema to apply pre-processing filters </name>
    -    </filterNames>
    -   </schema>
    - 
    - 
    -

    - TODO: Allow the schema to specify how many array elements to return per element, if the element is an array type

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

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static java.util.HashMap<java.lang.String,QuerySchema>schemaMap 
      -
    • -
    - -
      -
    • - - -

      Constructor Summary

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

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static booleancontainsSchema(java.lang.String schemaNameIn) -
      Checks whether or not (true/false) the given schema is loaded
      -
      static QuerySchemagetSchema(java.lang.String schemaName) 
      static java.util.HashMap<java.lang.String,QuerySchema>getSchemaMap() 
      static java.util.Set<java.lang.String>getSchemaNames() 
      static java.lang.StringgetSchemasString() 
      static voidinitialize() 
      static voidinitialize(boolean hdfs, - org.apache.hadoop.fs.FileSystem fs) 
      static voidprintSchemas() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Field Detail

      - - - -
        -
      • -

        schemaMap

        -
        public static java.util.HashMap<java.lang.String,QuerySchema> schemaMap
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Constructor Detail

      - - - -
        -
      • -

        LoadQuerySchemas

        -
        public LoadQuerySchemas()
        -
      • -
      -
    • -
    - -
      -
    • - - -

      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,QuerySchema> getSchemaMap()
        -
      • -
      - - - -
        -
      • -

        getSchemaNames

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

        getSchema

        -
        public static QuerySchema getSchema(java.lang.String schemaName)
        -
      • -
      - - - -
        -
      • -

        containsSchema

        -
        public static boolean containsSchema(java.lang.String schemaNameIn)
        -
        Checks whether or not (true/false) the given schema is loaded
        -
      • -
      - - - -
        -
      • -

        printSchemas

        -
        public static void printSchemas()
        -
      • -
      - - - -
        -
      • -

        getSchemasString

        -
        public static java.lang.String getSchemasString()
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/3cf5ed7e/pirk-site/javadocs/org/apache/pirk/schema/query/QuerySchema.html ---------------------------------------------------------------------- diff --git a/pirk-site/javadocs/org/apache/pirk/schema/query/QuerySchema.html b/pirk-site/javadocs/org/apache/pirk/schema/query/QuerySchema.html deleted file mode 100644 index 728fe18..0000000 --- a/pirk-site/javadocs/org/apache/pirk/schema/query/QuerySchema.html +++ /dev/null @@ -1,421 +0,0 @@ - - - - - -QuerySchema - - - - - - - - - - - -
-
org.apache.pirk.schema.query
-

Class QuerySchema

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • org.apache.pirk.schema.query.QuerySchema
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable
    -
    -
    -
    -
    public class QuerySchema
    -extends java.lang.Object
    -implements java.io.Serializable
    -
    Class to hold a query schema -

    - TODO: -

    - -Could easily add the ability for multiple filters (filter list capability) instead of just one

    -
    See Also:
    Serialized Form
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Field Summary

      - - - - - - - - - - -
      Fields 
      Modifier and TypeField and Description
      static java.lang.StringNO_FILTER 
      -
    • -
    - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      QuerySchema(java.lang.String schemaNameInput, - java.lang.String dataSchemaNameInput, - java.util.TreeSet<java.lang.String> elementNamesInput, - java.lang.String selectorNameInput, - int dataElementSizeInput, - java.util.HashSet<java.lang.String> filterElementNamesInput, - java.lang.String filterIn) 
      -
    • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      intgetDataElementSize() 
      java.lang.StringgetDataSchemaName() 
      java.util.TreeSet<java.lang.String>getElementNames() 
      java.lang.StringgetFilter() -
      Method to get the name of the filter class for this query
      -
      java.util.HashSet<java.lang.String>getFilterElementNames() 
      java.lang.ObjectgetFilterInstance() -
      Method to return the instance of the specified filter for this query
      -
      java.lang.StringgetSchemaName() 
      java.lang.StringgetSelectorName() 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        QuerySchema

        -
        public QuerySchema(java.lang.String schemaNameInput,
        -           java.lang.String dataSchemaNameInput,
        -           java.util.TreeSet<java.lang.String> elementNamesInput,
        -           java.lang.String selectorNameInput,
        -           int dataElementSizeInput,
        -           java.util.HashSet<java.lang.String> filterElementNamesInput,
        -           java.lang.String filterIn)
        -            throws java.lang.Exception
        -
        Throws:
        -
        java.lang.Exception
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getSchemaName

        -
        public java.lang.String getSchemaName()
        -
      • -
      - - - -
        -
      • -

        getDataSchemaName

        -
        public java.lang.String getDataSchemaName()
        -
      • -
      - - - -
        -
      • -

        getElementNames

        -
        public java.util.TreeSet<java.lang.String> getElementNames()
        -
      • -
      - - - -
        -
      • -

        getSelectorName

        -
        public java.lang.String getSelectorName()
        -
      • -
      - - - -
        -
      • -

        getDataElementSize

        -
        public int getDataElementSize()
        -
      • -
      - - - -
        -
      • -

        getFilter

        -
        public java.lang.String getFilter()
        -
        Method to get the name of the filter class for this query
        -
      • -
      - - - -
        -
      • -

        getFilterElementNames

        -
        public java.util.HashSet<java.lang.String> getFilterElementNames()
        -
      • -
      - - - -
        -
      • -

        getFilterInstance

        -
        public java.lang.Object getFilterInstance()
        -                                   throws java.lang.Exception
        -
        Method to return the instance of the specified filter for this query -

        - Will return null if no filter has been specified for the query

        -
        Throws:
        -
        java.lang.Exception
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/3cf5ed7e/pirk-site/javadocs/org/apache/pirk/schema/query/class-use/LoadQuerySchemas.html ---------------------------------------------------------------------- diff --git a/pirk-site/javadocs/org/apache/pirk/schema/query/class-use/LoadQuerySchemas.html b/pirk-site/javadocs/org/apache/pirk/schema/query/class-use/LoadQuerySchemas.html deleted file mode 100644 index 2455fb4..0000000 --- a/pirk-site/javadocs/org/apache/pirk/schema/query/class-use/LoadQuerySchemas.html +++ /dev/null @@ -1,115 +0,0 @@ - - - - - -Uses of Class org.apache.pirk.schema.query.LoadQuerySchemas - - - - - - - - - - -
-

Uses of Class
org.apache.pirk.schema.query.LoadQuerySchemas

-
-
No usage of org.apache.pirk.schema.query.LoadQuerySchemas
- - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/3cf5ed7e/pirk-site/javadocs/org/apache/pirk/schema/query/class-use/QuerySchema.html ---------------------------------------------------------------------- diff --git a/pirk-site/javadocs/org/apache/pirk/schema/query/class-use/QuerySchema.html b/pirk-site/javadocs/org/apache/pirk/schema/query/class-use/QuerySchema.html deleted file mode 100644 index aeb2318..0000000 --- a/pirk-site/javadocs/org/apache/pirk/schema/query/class-use/QuerySchema.html +++ /dev/null @@ -1,271 +0,0 @@ - - - - - -Uses of Class org.apache.pirk.schema.query.QuerySchema - - - - - - - - - - -
-

Uses of Class
org.apache.pirk.schema.query.QuerySchema

-
-
- -
- - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/3cf5ed7e/pirk-site/javadocs/org/apache/pirk/schema/query/filter/DataFilter.html ---------------------------------------------------------------------- diff --git a/pirk-site/javadocs/org/apache/pirk/schema/query/filter/DataFilter.html b/pirk-site/javadocs/org/apache/pirk/schema/query/filter/DataFilter.html deleted file mode 100644 index 6730a8d..0000000 --- a/pirk-site/javadocs/org/apache/pirk/schema/query/filter/DataFilter.html +++ /dev/null @@ -1,225 +0,0 @@ - - - - - -DataFilter - - - - - - - - - - - -
-
org.apache.pirk.schema.query.filter
-

Interface DataFilter

-
-
-
-
    -
  • -
    -
    All Superinterfaces:
    -
    java.io.Serializable
    -
    -
    -
    All Known Implementing Classes:
    -
    StopListFilter
    -
    -
    -
    -
    public interface DataFilter
    -extends java.io.Serializable
    -
    Interface to filter data elements as they are read in for processing -

    - All custom filters must implement this interface

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

      Method Summary

      - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      booleanfilterDataElement(org.apache.hadoop.io.MapWritable dataElement, - DataSchema dSchema) -
      Filter the data element
      -
      -
    • -
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        filterDataElement

        -
        boolean filterDataElement(org.apache.hadoop.io.MapWritable dataElement,
        -                        DataSchema dSchema)
        -
        Filter the data element -

        - Returns true if we are to filter out the element, false otherwise

        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/3cf5ed7e/pirk-site/javadocs/org/apache/pirk/schema/query/filter/FilterFactory.html ---------------------------------------------------------------------- diff --git a/pirk-site/javadocs/org/apache/pirk/schema/query/filter/FilterFactory.html b/pirk-site/javadocs/org/apache/pirk/schema/query/filter/FilterFactory.html deleted file mode 100644 index e53f16f..0000000 --- a/pirk-site/javadocs/org/apache/pirk/schema/query/filter/FilterFactory.html +++ /dev/null @@ -1,262 +0,0 @@ - - - - - -FilterFactory - - - - - - - - - - - -
-
org.apache.pirk.schema.query.filter
-

Class FilterFactory

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • org.apache.pirk.schema.query.filter.FilterFactory
    • -
    -
  • -
-
-
    -
  • -
    -
    -
    public class FilterFactory
    -extends java.lang.Object
    -
    Factory class to instantiate filters and set the necessary properties map
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

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

      Method Summary

      - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      static java.lang.ObjectgetFilter(java.lang.String filterName, - QuerySchema qSchema) 
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        FilterFactory

        -
        public FilterFactory()
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        getFilter

        -
        public static java.lang.Object getFilter(java.lang.String filterName,
        -                         QuerySchema qSchema)
        -                                  throws java.lang.Exception
        -
        Throws:
        -
        java.lang.Exception
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - - http://git-wip-us.apache.org/repos/asf/incubator-pirk/blob/3cf5ed7e/pirk-site/javadocs/org/apache/pirk/schema/query/filter/StopListFilter.html ---------------------------------------------------------------------- diff --git a/pirk-site/javadocs/org/apache/pirk/schema/query/filter/StopListFilter.html b/pirk-site/javadocs/org/apache/pirk/schema/query/filter/StopListFilter.html deleted file mode 100644 index 697f59c..0000000 --- a/pirk-site/javadocs/org/apache/pirk/schema/query/filter/StopListFilter.html +++ /dev/null @@ -1,277 +0,0 @@ - - - - - -StopListFilter - - - - - - - - - - - -
-
org.apache.pirk.schema.query.filter
-

Class StopListFilter

-
-
-
    -
  • java.lang.Object
  • -
  • -
      -
    • org.apache.pirk.schema.query.filter.StopListFilter
    • -
    -
  • -
-
-
    -
  • -
    -
    All Implemented Interfaces:
    -
    java.io.Serializable, DataFilter
    -
    -
    -
    -
    public class StopListFilter
    -extends java.lang.Object
    -implements DataFilter
    -
    Filter class to filter data elements based upon a stoplist applied to specified field elements
    -
    See Also:
    Serialized Form
    -
  • -
-
-
-
    -
  • - -
      -
    • - - -

      Constructor Summary

      - - - - - - - - -
      Constructors 
      Constructor and Description
      StopListFilter(java.util.HashSet<java.lang.String> filterSetIn, - java.util.HashSet<java.lang.String> stopListIn) 
      -
    • -
    - -
      -
    • - - -

      Method Summary

      - - - - - - - - - - -
      Methods 
      Modifier and TypeMethod and Description
      booleanfilterDataElement(org.apache.hadoop.io.MapWritable dataElement, - DataSchema dSchema) -
      Filter the data element
      -
      -
        -
      • - - -

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      - - - -
        -
      • -

        StopListFilter

        -
        public StopListFilter(java.util.HashSet<java.lang.String> filterSetIn,
        -              java.util.HashSet<java.lang.String> stopListIn)
        -
      • -
      -
    • -
    - -
      -
    • - - -

      Method Detail

      - - - -
        -
      • -

        filterDataElement

        -
        public boolean filterDataElement(org.apache.hadoop.io.MapWritable dataElement,
        -                        DataSchema dSchema)
        -
        Description copied from interface: DataFilter
        -
        Filter the data element -

        - Returns true if we are to filter out the element, false otherwise

        -
        -
        Specified by:
        -
        filterDataElement in interface DataFilter
        -
        -
      • -
      -
    • -
    -
  • -
-
-
- - - - - - -